diff --git a/openapi-specs/sdwan/legacy/Applications.yaml b/openapi-specs/sdwan/legacy/Applications.yaml index 2d68bb0fd..e21c28ee9 100644 --- a/openapi-specs/sdwan/legacy/Applications.yaml +++ b/openapi-specs/sdwan/legacy/Applications.yaml @@ -2,21 +2,9 @@ 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: @@ -26,28 +14,6 @@ components: - 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 AppDefQuery: properties: aggregate: @@ -115,7 +81,7 @@ components: ' format: int64 type: integer - AppDefQueryFilterTransformedV2N3: + AppDefQueryFilterTransformed: properties: abbreviation: description: 'Abbreviation of the application name. @@ -123,9 +89,7 @@ components: ' type: string aggregate_flows: - description: 'The aggregate flows. - - ' + description: Aggregate Flows type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined @@ -133,11 +97,6 @@ components: ' type: string - app_unreachability_detection: - description: 'Application unreachability detection. - - ' - type: boolean category: description: 'The application category. @@ -226,33 +185,23 @@ components: ' type: string ingress_traffic_pct: - description: "The app def ingress traffic. Application ingress traffic percentage\ - \ should be in between 1-99. \n" + 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) ' format: int32 type: integer ip_rules: - description: 'Applicable for L3/L4 applications. These are IP Prefix rules - used to identify the application viz protocol, dscp, source & destination - prefixes and source & destination prefixes. - - ' + description: 'Ip Rules: Valid Size(max = 16, error = APPDEF_CONFIG_MAX_SIZE_EXCEED: + Allowed max size is 16 for each of them - tcp_rules, ip_rules and udp_rules., + min = 0) ' items: type: object type: array - is_deprecated: - description: 'Deprecated application definitions. - - ' - type: boolean - network_scan_application: - description: 'If true, it enables Network Scan App to designate custom applications - as network scan applications. - - ' - type: boolean order_number: - description: "The app config order number. Order number should be between\ - \ 1-65535. \n" + 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: @@ -261,17 +210,14 @@ components: ' type: boolean - parent_id: - description: 'Parent app ID. + path_affinity: + description: 'This parameter defines the path affinity characteristics to + consider during flow decision making. Allowed values: "none" "weak" "strict". + If path affinity is none or weak and a better path is available, flows + will be moved to a new path. If path affinity is strict, all application + flows will continue on the same path. ' - type: string - path_affinity: - description: "This parameter defines the path affinity characteristics to\ - \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ - \ \"strict\". If path affinity is none or weak and a better path is available,\ - \ flows will be moved to a new path. If path affinity is strict, all application\ - \ flows will continue on the same path. \n" enum: - none - weak @@ -290,25 +236,27 @@ components: ' type: boolean tags: - description: 'A information field that can be added to identify the application. - Maximum 10 Unique tags of length 1024 each are allowed. - - ' + 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) ' items: description: Tags type: string type: array tcp_rules: description: 'For TCP applications, this dictionary will include information - on client & server prefix filters, server & client ports, DCSP settings. + on client & server prefix filters, server & client ports, and DCSP settings. ' items: 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 @@ -318,19 +266,13 @@ components: items: type: object type: array - use_parentapp_network_policy: - description: 'If enabled, policy rule defined for the parent application - will be used to make routing decisions for this app. - - ' - type: boolean required: - app_type - transfer_type - display_name - ingress_traffic_pct - path_affinity - AppDefQueryFilterTransformedV2N4: + AppDefQueryFilterTransformedV2N3: properties: abbreviation: description: 'Abbreviation of the application name. @@ -338,7 +280,9 @@ components: ' type: string aggregate_flows: - description: "Aggregate flows enabled. True / False. \n" + description: 'The aggregate flows. + + ' type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined @@ -347,7 +291,7 @@ components: ' type: string app_unreachability_detection: - description: 'Aggregate reachability detection. True / False. + description: 'Application unreachability detection. ' type: boolean @@ -439,10 +383,8 @@ components: ' type: string ingress_traffic_pct: - description: '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: @@ -466,8 +408,8 @@ components: ' type: boolean order_number: - description: "The order number. Order number should be between 1-65535L.\ - \ \n" + description: "The app config order number. Order number should be between\ + \ 1-65535. \n" format: int32 type: integer overrides_allowed: @@ -476,17 +418,6 @@ components: ' type: boolean - p_category: - description: 'Parent app category. - - ' - type: string - p_parent_id: - description: P Parent Id - type: string - p_sub_category: - description: "Parent app sub-category. \n" - type: string parent_id: description: 'Parent app ID. @@ -509,14 +440,6 @@ components: ' format: int32 type: integer - supported_engines: - description: "Supported engines values. \n" - enum: - - ave - - ave-all - - panos - - all - type: string system_app_overridden: description: 'If true, it indicates the an application override has been added. @@ -564,29 +487,19 @@ components: - display_name - ingress_traffic_pct - path_affinity - AppDefScreenV2N4: + AppDefScreenV2: properties: abbreviation: description: 'Abbreviation of the application name. ' type: string - aggregate_flows: - description: 'The aggregate flows. - - ' - type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined applications are not allowed to be edited using appdefs. ' type: string - app_unreachability_detection: - description: 'Application unreachability detection. - - ' - type: boolean category: description: 'The application category. @@ -648,16 +561,10 @@ components: ' format: int32 type: integer - description: - description: 'Description for the application. Max size = 256. - - ' display_name: - description: 'This is the name of the application that is visible on the - Controller UI. Application display name is required and cannot be null. - Max size = 64. - - ' + description: "This is the name of the application that is visible on the\ + \ Controller UI. Application display name is required and cannot be null.\ + \ Max size = 64. \n" type: string domains: description: 'Applicable for layer 7 applications. List of application domains. @@ -670,66 +577,14 @@ components: type: string type: array id: - description: 'Application ID. - - ' + description: "Application ID. \n" type: string ingress_traffic_pct: - description: 'The app def ingress traffic. Application ingress traffic percentage - should be in between 1-99. - - ' - format: int32 - type: integer - ip_rules: - description: 'Applicable for L3/L4 applications. These are IP Prefix rules - used to identify the application viz protocol, dscp, source & destination - prefixes and source & destination prefixes. - - ' - items: - type: object - type: array - is_deprecated: - description: 'Deprecated application definitions. - - ' - type: boolean - network_scan_application: - description: 'If true, it enables Network Scan App to designate custom applications - as network scan applications. - - ' - type: boolean - order_number: - description: "The app config order number. Order number should be between\ - \ 1-65535. \n" + description: 'Ingress Traffic Pct: Required(message = required) DecimalMin(inclusive + = true, APPDEF_CONFIG_INGRESS_MIN, value = 1) DecimalMax(inclusive = true, + APPDEF_CONFIG_INGRESS_MAX, value = 99) ' format: int32 type: integer - overrides_allowed: - description: 'If true, this enables an update to be added using the appdef_overrides - API. - - ' - type: boolean - p_category: - description: 'Parent app category. - - ' - type: string - p_parent_id: - description: P Parent Id - type: string - p_sub_category: - description: 'Parent app sub-category. - - ' - type: string - parent_id: - description: 'Parent app ID. - - ' - type: string path_affinity: description: "This parameter defines the path affinity characteristics to\ \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ @@ -741,46 +596,16 @@ components: - weak - strict type: string - session_timeout: - description: 'Application session timeout should be in between 0-44000. - - ' - format: int32 - type: integer - supported_engines: - description: "Supported engines. \n" - enum: - - ave - - ave-all - - panos - - all - type: string - system_app_overridden: - description: 'If true, it indicates the an application override has been - added. - - ' - type: boolean - tags: - description: 'A information field that can be added to identify the application. - Maximum 10 Unique tags of length 1024 each are allowed. - - ' - items: - description: Tags - type: string - type: array tcp_rules: - description: 'For TCP applications, this dictionary will include information - on client & server prefix filters, server & client ports, DCSP settings. - - ' + description: "For TCP applications, this dictionary will include information\ + \ on client & server prefix filters, server & client ports, and DCSP settings.\ + \ \n" items: - type: string + $ref: '#/components/schemas/TcpRule' 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 @@ -788,21 +613,16 @@ components: ' items: - type: object + $ref: '#/components/schemas/UdpRule' type: array - use_parentapp_network_policy: - description: 'If enabled, policy rule defined for the parent application - will be used to make routing decisions for this app. - - ' - type: boolean required: + - category - app_type - transfer_type - display_name - ingress_traffic_pct - path_affinity - AppDefScreenV2N5: + AppDefScreenV2N1: properties: abbreviation: description: 'Abbreviation of the application name. @@ -810,9 +630,7 @@ components: ' type: string aggregate_flows: - description: 'Aggregate flows enabled. True / False. - - ' + description: Aggregate Flows type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined @@ -820,11 +638,6 @@ components: ' type: string - app_unreachability_detection: - description: 'Aggregate reachability detection. True / False. - - ' - type: boolean category: description: 'The application category. @@ -891,11 +704,10 @@ components: ' display_name: - description: 'This is the name of the application that is visible on the - Controller UI. Application display name is required and cannot be null. - Max size = 64. - - ' + description: 'Display Name: NotBlank(error = APPDEF_CONFIG_INVALID_DISPLAYNAME: + Application display name is required and cannot be null.) Size(max = 64, + error = APPDEF_CONFIG_INVALID_DISPLAYNAME: Application display name is + required and cannot be null., min = 0) ' type: string domains: description: 'Applicable for layer 7 applications. List of application domains. @@ -913,10 +725,11 @@ components: ' type: string ingress_traffic_pct: - description: 'Application ingress traffic percentage should be in between - 1-99. - - ' + 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) ' format: int32 type: integer ip_rules: @@ -928,20 +741,9 @@ components: items: type: object type: array - is_deprecated: - description: 'Deprecated application definitions. - - ' - type: boolean - network_scan_application: - description: 'If true, it enables Network Scan App to designate custom applications - as network scan applications. - - ' - type: boolean order_number: - description: "The order number. Order number should be between 1-65535L.\ - \ \n" + 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: @@ -950,28 +752,14 @@ components: ' type: boolean - p_category: - description: 'Parent app category. - - ' - type: string - p_parent_id: - description: P Parent Id - type: string - p_sub_category: - description: 'Parent app sub-category. + path_affinity: + description: 'This parameter defines the path affinity characteristics to + consider during flow decision making. Allowed values: "none" "weak" "strict". + If path affinity is none or weak and a better path is available, flows + will be moved to a new path. If path affinity is strict, all application + flows will continue on the same path. ' - type: string - parent_id: - description: "Parent app ID. \n" - type: string - path_affinity: - description: "This parameter defines the path affinity characteristics to\ - \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ - \ \"strict\". If path affinity is none or weak and a better path is available,\ - \ flows will be moved to a new path. If path affinity is strict, all application\ - \ flows will continue on the same path. \n" enum: - none - weak @@ -983,16 +771,6 @@ components: ' format: int32 type: integer - supported_engines: - description: 'Supported engines values. - - ' - enum: - - ave - - ave-all - - panos - - all - type: string system_app_overridden: description: 'If true, it indicates the an application override has been added. @@ -1017,8 +795,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 @@ -1028,94 +808,31 @@ components: items: type: object type: array - use_parentapp_network_policy: - description: 'If enabled, policy rule defined for the parent application - will be used to make routing decisions for this app. - - ' - type: boolean required: - app_type - transfer_type - display_name - ingress_traffic_pct - path_affinity - AppDefTenantVersion: - properties: - app_version: - description: 'Version of the app. - - ' - type: string - disabled: - description: 'Disable the app. - - ' - type: boolean - disabled_reason: - description: 'Reason to disable the app. - - ' - type: string - id: - description: 'Application ID. - - ' - type: string - inactive: - description: 'App status (active or inactive). - - ' - type: boolean - inactive_reason: - description: 'Reason for app being inactive. - - ' - type: string - region: - description: 'App region. - - ' - type: string - reqState: - description: 'App states. - - ' - enum: - - APPDEF_APPS_REQ_PENDING - - APPDEF_APPS_CREATE_IN_PROGRESS - - APPDEF_CODECS_CREATE_IN_PROGRESS - - APPDEF_CREATE_COMPLETE - - APPDEF_CREATE_FAILED - type: string - sigfile_url: - description: 'URL of the sigfile. - - ' - type: string - tenant_id: - description: 'The tenant ID. - - ' - type: string - uApp_version: - description: UApp Version - type: string - required: - - tenant_id - AppDefV2: + AppDefScreenV2N2: properties: abbreviation: description: 'Abbreviation of the application name. ' type: string + aggregate_flows: + description: Aggregate Flows + type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined applications are not allowed to be edited using appdefs. ' type: string + app_unreachability_detection: + description: App Unreachability Detection + type: boolean category: description: 'The application category. @@ -1177,6 +894,10 @@ components: ' format: int32 type: integer + description: + description: 'Description for the application. Max size = 256. + + ' display_name: description: 'This is the name of the application that is visible on the Controller UI. Application display name is required and cannot be null. @@ -1200,12 +921,49 @@ components: ' type: string ingress_traffic_pct: - description: 'The app def config ingress traffic pct values. (Min value - = 1, Max value = 99). + 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) ' + format: int32 + type: integer + ip_rules: + description: 'Applicable for L3/L4 applications. These are IP Prefix rules + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. + + ' + items: + type: object + type: array + is_deprecated: + description: 'Deprecated application definitions. + + ' + type: boolean + network_scan_application: + description: 'If true, it enables Network Scan App to designate custom applications + as network scan applications. ' + 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) ' format: int32 type: integer + overrides_allowed: + description: 'If true, this enables an update to be added using the appdef_overrides + API. + + ' + type: boolean + parent_id: + description: 'Parent app ID. + + ' + type: string path_affinity: description: "This parameter defines the path affinity characteristics to\ \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ @@ -1217,13 +975,34 @@ components: - weak - strict type: string + session_timeout: + description: 'Application session timeout should be in between 0-44000. + + ' + format: int32 + type: integer + system_app_overridden: + description: 'If true, it indicates the an application override has been + added. + + ' + type: boolean + 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) ' + items: + description: Tags + type: string + type: array tcp_rules: description: 'For TCP applications, this dictionary will include information on client & server prefix filters, server & client ports, DCSP settings. ' items: - $ref: '#/components/schemas/TcpRule' + type: string type: array transfer_type: description: "Application transfer type. Allowed values: transactional,\ @@ -1235,16 +1014,21 @@ components: ' items: - $ref: '#/components/schemas/UdpRule' + type: object type: array + use_parentapp_network_policy: + description: 'If enabled, policy rule defined for the parent application + will be used to make routing decisions for this app. + + ' + type: boolean required: - - category - app_type - transfer_type - display_name - ingress_traffic_pct - path_affinity - AppDefV2N4: + AppDefScreenV2N3: properties: abbreviation: description: 'Abbreviation of the application name. @@ -1252,9 +1036,7 @@ components: ' type: string aggregate_flows: - description: 'The aggregate flows. - - ' + description: Aggregate Flows type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined @@ -1263,9 +1045,7 @@ components: ' type: string app_unreachability_detection: - description: 'Application unreachability detection. - - ' + description: App Unreachability Detection type: boolean category: description: 'The application category. @@ -1355,10 +1135,11 @@ components: ' type: string ingress_traffic_pct: - description: 'The app def ingress traffic. Application ingress traffic percentage - should be in between 1-99. - - ' + 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) ' format: int32 type: integer ip_rules: @@ -1392,19 +1173,6 @@ components: ' type: boolean - p_category: - description: 'Parent app category. - - ' - type: string - p_parent_id: - description: P Parent Id - type: string - p_sub_category: - description: 'Parent app sub-category. - - ' - type: string parent_id: description: 'Parent app ID. @@ -1427,16 +1195,6 @@ components: ' format: int32 type: integer - supported_engines: - description: 'Supported engines. - - ' - enum: - - ave - - ave-all - - panos - - all - type: string system_app_overridden: description: 'If true, it indicates the an application override has been added. @@ -1484,7 +1242,7 @@ components: - display_name - ingress_traffic_pct - path_affinity - AppDefV2N5: + AppDefScreenV2N4: properties: abbreviation: description: 'Abbreviation of the application name. @@ -1595,8 +1353,10 @@ components: ' type: string ingress_traffic_pct: - description: "The app def ingress traffic. Application ingress traffic percentage\ - \ should be in between 1-99. \n" + description: 'The app def ingress traffic. Application ingress traffic percentage + should be in between 1-99. + + ' format: int32 type: integer ip_rules: @@ -1620,10 +1380,8 @@ components: ' type: boolean order_number: - description: 'The app config order number. Order number should be between - 1-65535. - - ' + description: "The app config order number. Order number should be between\ + \ 1-65535. \n" format: int32 type: integer overrides_allowed: @@ -1668,7 +1426,7 @@ components: format: int32 type: integer supported_engines: - description: "Supported engines. \n" + description: "Supported engines. \n" enum: - ave - ave-all @@ -1699,10 +1457,8 @@ components: type: string type: array transfer_type: - description: 'Application transfer type. Allowed values: transactional, - bulk, rt-audio, rt-video. - - ' + description: "Application transfer type. Allowed values: transactional,\ + \ bulk, rt-audio, rt-video. \n" type: string udp_rules: description: 'For UDP applications, this dictionary will include information @@ -1724,34 +1480,98 @@ components: - display_name - ingress_traffic_pct - path_affinity - AppdefOverrideScreenV2N2: + AppDefTenantVersion: properties: - aggregate_flows: - description: 'The aggregate flows. + app_version: + description: 'Version of the app. ' - type: boolean - app_unreachability_detection: - description: 'Application unreachability detection. + type: string + disabled: + description: 'Disable the app. ' type: boolean - category: - description: 'The application category. + disabled_reason: + description: 'Reason to disable the app. ' - enum: - - anonymity - - anti-virus - - auth - - backup - - cad - - collaboration - - conference - - crm - - db-mgmt - - email - - enterprise + type: string + id: + description: 'Application ID. + + ' + type: string + inactive: + description: 'App status (active or inactive). + + ' + type: boolean + inactive_reason: + description: 'Reason for app being inactive. + + ' + type: string + region: + description: 'App region. + + ' + type: string + reqState: + description: 'App states. + + ' + enum: + - APPDEF_APPS_REQ_PENDING + - APPDEF_APPS_CREATE_IN_PROGRESS + - APPDEF_CODECS_CREATE_IN_PROGRESS + - APPDEF_CREATE_COMPLETE + - APPDEF_CREATE_FAILED + type: string + sigfile_url: + description: 'URL of the sigfile. + + ' + type: string + tenant_id: + description: 'The tenant ID. + + ' + type: string + uApp_version: + description: UApp Version + type: string + required: + - tenant_id + AppDefV2: + properties: + abbreviation: + description: 'Abbreviation of the application name. + + ' + type: string + app_type: + description: 'Type of application. Allowed values: custom. System defined + applications are not allowed to be edited using appdefs. + + ' + type: string + category: + description: 'The application category. + + ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise - file-sharing - file-system - file-transfer @@ -1795,11 +1615,15 @@ components: be in between 0-44000. ' + format: int32 type: integer - description: - description: 'Description for the application. Max size = 256. + display_name: + description: 'This is the name of the application that is visible on the + Controller UI. Application display name is required and cannot be null. + Max size = 64. ' + type: string domains: description: 'Applicable for layer 7 applications. List of application domains. Maximum 16 valid domains are allowed and each domain should not exceed @@ -1820,73 +1644,26 @@ components: = 1, Max value = 99). ' + format: int32 type: integer - ip_rules: - description: 'Applicable for L3/L4 applications. These are IP Prefix rules - used to identify the application viz protocol, dscp, source & destination - prefixes and source & destination prefixes. - - ' - items: - $ref: '#/components/schemas/IPRuleV2' - type: array - override_default_ip_rules: - description: 'The default override IP rules. - - ' - type: boolean - override_default_tcp_rules: - description: 'The default override TCP rules. - - ' - type: boolean - override_default_udp_rules: - description: 'The default override UDP rules. - - ' - type: boolean - override_domains: - description: 'List the override domains. - - ' - type: boolean - overrides_disable: - description: 'List the disabled overrides. - - ' - type: boolean path_affinity: description: "This parameter defines the path affinity characteristics to\ \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ \ \"strict\". If path affinity is none or weak and a better path is available,\ \ flows will be moved to a new path. If path affinity is strict, all application\ - \ flows will continue on the same path. \n" + \ flows will continue on the same path. \n" enum: - none - weak - strict type: string - session_timeout: - description: 'Application session timeout should be in between 0-44000. - - ' - type: integer - tags: - description: 'A information field that can be added to identify the application. - Maximum 10 Unique tags of length 1024 each are allowed. - - ' - items: - description: Tags - type: string - type: array tcp_rules: description: 'For TCP applications, this dictionary will include information on client & server prefix filters, server & client ports, DCSP settings. ' items: - $ref: '#/components/schemas/TcpRuleV2' + $ref: '#/components/schemas/TcpRule' type: array transfer_type: description: "Application transfer type. Allowed values: transactional,\ @@ -1898,26 +1675,31 @@ components: ' items: - $ref: '#/components/schemas/UdpRuleV2' + $ref: '#/components/schemas/UdpRule' type: array - use_parentapp_network_policy: - description: 'If enabled, policy rule defined for the parent application - will be used to make routing decisions for this app. - - ' - type: boolean - AppdefOverrideScreenV2N3: + required: + - category + - app_type + - transfer_type + - display_name + - ingress_traffic_pct + - path_affinity + AppDefV2N1: properties: - aggregate_flows: - description: 'The aggregate flows. + abbreviation: + description: 'Abbreviation of the application name. ' + type: string + aggregate_flows: + description: Aggregate Flows type: boolean - app_unreachability_detection: - description: 'Application unreachability detection. + app_type: + description: 'Type of application. Allowed values: custom. System defined + applications are not allowed to be edited using appdefs. ' - type: boolean + type: string category: description: 'The application category. @@ -1977,11 +1759,18 @@ components: be in between 0-44000. ' + format: int32 type: integer description: description: 'Description for the application. Max size = 256. ' + display_name: + description: 'Display Name: NotBlank(error = APPDEF_CONFIG_INVALID_DISPLAYNAME: + Application display name is required and cannot be null.) Size(max = 64, + error = APPDEF_CONFIG_INVALID_DISPLAYNAME: Application display name is + required and cannot be null., min = 0) ' + type: string domains: description: 'Applicable for layer 7 applications. List of application domains. Maximum 16 valid domains are allowed and each domain should not exceed @@ -1998,10 +1787,12 @@ components: ' type: string ingress_traffic_pct: - description: 'The app def ingress traffic. Application ingress traffic percentage - should be in between 1-99. - - ' + 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) ' + format: int32 type: integer ip_rules: description: 'Applicable for L3/L4 applications. These are IP Prefix rules @@ -2010,52 +1801,28 @@ components: ' items: - $ref: '#/components/schemas/IPRuleV2' + type: object type: array - override_default_ip_rules: - description: 'The default override IP rules. - - ' - type: boolean - override_default_tcp_rules: - description: 'The default override TCP rules. - - ' - type: boolean - override_default_udp_rules: - description: 'The default override UDP rules. - - ' - type: boolean - override_domains: - description: 'List the override domains. - - ' - type: boolean - overrides_disable: - description: 'List the disabled overrides. + order_number: + 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: + description: 'If true, this enables an update to be added using the appdef_overrides + API. ' type: boolean - p_category: - description: 'Parent App Category. + path_affinity: + description: 'This parameter defines the path affinity characteristics to + consider during flow decision making. Allowed values: "none" "weak" "strict". + If path affinity is none or weak and a better path is available, flows + will be moved to a new path. If path affinity is strict, all application + flows will continue on the same path. ' enum: - - business-systems - - collaboration - - general-internet - - media - - networking - - saas - type: string - path_affinity: - description: "This parameter defines the path affinity characteristics to\ - \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ - \ \"strict\". If path affinity is none or weak and a better path is available,\ - \ flows will be moved to a new path. If path affinity is strict, all application\ - \ flows will continue on the same path. \n" - enum: - none - weak - strict @@ -2064,7 +1831,14 @@ components: description: 'Application session timeout should be in between 0-44000. ' + format: int32 type: integer + system_app_overridden: + description: 'If true, it indicates the an application override has been + added. + + ' + type: boolean tags: description: 'A information field that can be added to identify the application. Maximum 10 Unique tags of length 1024 each are allowed. @@ -2080,11 +1854,13 @@ components: ' items: - $ref: '#/components/schemas/TcpRuleV2' + 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 @@ -2092,25 +1868,32 @@ components: ' items: - $ref: '#/components/schemas/UdpRuleV2' + type: object type: array - use_parentapp_network_policy: - description: 'If enabled, policy rule defined for the parent application - will be used to make routing decisions for this app. + required: + - app_type + - transfer_type + - display_name + - ingress_traffic_pct + - path_affinity + AppDefV2N2: + properties: + abbreviation: + description: 'Abbreviation of the application name. ' - type: boolean - AppdefOverrideV2N2: - properties: + type: string aggregate_flows: - description: 'The aggregate flows. - - ' + description: Aggregate Flows type: boolean - app_unreachability_detection: - description: 'Application unreachability detection. + app_type: + description: 'Type of application. Allowed values: custom. System defined + applications are not allowed to be edited using appdefs. ' + type: string + app_unreachability_detection: + description: App Unreachability Detection type: boolean category: description: 'The application category. @@ -2171,11 +1954,19 @@ components: be in between 0-44000. ' + format: int32 type: integer description: - description: 'Description for the application. Max size = 256. + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + display_name: + description: 'This is the name of the application that is visible on the + Controller UI. Application display name is required and cannot be null. + Max size = 64. ' + type: string domains: description: 'Applicable for layer 7 applications. List of application domains. Maximum 16 valid domains are allowed and each domain should not exceed @@ -2192,10 +1983,12 @@ components: ' type: string ingress_traffic_pct: - description: 'The app def ingress traffic. Application ingress traffic percentage - should be in between 1-99. - - ' + 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) ' + format: int32 type: integer ip_rules: description: 'Applicable for L3/L4 applications. These are IP Prefix rules @@ -2204,39 +1997,41 @@ components: ' items: - $ref: '#/components/schemas/IPRuleV2' + type: object type: array - override_default_ip_rules: - description: 'The default override IP rules. - - ' - type: boolean - override_default_tcp_rules: - description: 'The default override TCP rules. + is_deprecated: + description: 'Deprecated application definitions. ' type: boolean - override_default_udp_rules: - description: 'The default override UDP rules. + network_scan_application: + description: 'If true, it enables Network Scan App to designate custom applications + as network scan applications. ' type: boolean - override_domains: - description: 'List the override domains. + order_number: + 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: + description: 'If true, this enables an update to be added using the appdef_overrides + API. ' type: boolean - overrides_disable: - description: 'List the disabled overrides. + parent_id: + description: 'Parent app ID. ' - type: boolean + type: string path_affinity: description: "This parameter defines the path affinity characteristics to\ \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ \ \"strict\". If path affinity is none or weak and a better path is available,\ \ flows will be moved to a new path. If path affinity is strict, all application\ - \ flows will continue on the same path. \n" + \ flows will continue on the same path. \n" enum: - none - weak @@ -2246,12 +2041,19 @@ components: description: 'Application session timeout should be in between 0-44000. ' + format: int32 type: integer - tags: - description: 'A information field that can be added to identify the application. - Maximum 10 Unique tags of length 1024 each are allowed. + system_app_overridden: + description: 'If true, it indicates the an application override has been + added. ' + type: boolean + 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) ' items: description: Tags type: string @@ -2262,7 +2064,7 @@ components: ' items: - $ref: '#/components/schemas/TcpRuleV2' + type: string type: array transfer_type: description: "Application transfer type. Allowed values: transactional,\ @@ -2274,7 +2076,7 @@ components: ' items: - $ref: '#/components/schemas/UdpRuleV2' + type: object type: array use_parentapp_network_policy: description: 'If enabled, policy rule defined for the parent application @@ -2282,17 +2084,30 @@ components: ' type: boolean - AppdefOverrideV2N3: + required: + - app_type + - transfer_type + - display_name + - ingress_traffic_pct + - path_affinity + AppDefV2N3: properties: - aggregate_flows: - description: 'The aggregate flows. + abbreviation: + description: 'Abbreviation of the application name. ' + type: string + aggregate_flows: + description: Aggregate Flows type: boolean - app_unreachability_detection: - description: 'Application unreachability detection. + app_type: + description: 'Type of application. Allowed values: custom. System defined + applications are not allowed to be edited using appdefs. ' + type: string + app_unreachability_detection: + description: App Unreachability Detection type: boolean category: description: 'The application category. @@ -2353,11 +2168,19 @@ components: be in between 0-44000. ' + format: int32 type: integer description: description: 'Description for the application. Max size = 256. ' + display_name: + description: 'This is the name of the application that is visible on the + Controller UI. Application display name is required and cannot be null. + Max size = 64. + + ' + type: string domains: description: 'Applicable for layer 7 applications. List of application domains. Maximum 16 valid domains are allowed and each domain should not exceed @@ -2374,10 +2197,12 @@ components: ' type: string ingress_traffic_pct: - description: 'The app def ingress traffic. Application ingress traffic percentage - should be in between 1-99. - - ' + 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) ' + format: int32 type: integer ip_rules: description: 'Applicable for L3/L4 applications. These are IP Prefix rules @@ -2386,51 +2211,41 @@ components: ' items: - $ref: '#/components/schemas/IPRuleV2' + type: object type: array - override_default_ip_rules: - description: 'The default override IP rules. - - ' - type: boolean - override_default_tcp_rules: - description: 'The default override TCP rules. - - ' - type: boolean - override_default_udp_rules: - description: 'The default override UDP rules. + is_deprecated: + description: 'Deprecated application definitions. ' type: boolean - override_domains: - description: 'List the override domains. + network_scan_application: + description: 'If true, it enables Network Scan App to designate custom applications + as network scan applications. ' type: boolean - overrides_disable: - description: 'List the disabled overrides. + order_number: + 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: + description: 'If true, this enables an update to be added using the appdef_overrides + API. ' type: boolean - p_category: - description: 'Parent App Category. + parent_id: + description: 'Parent app ID. ' - enum: - - business-systems - - collaboration - - general-internet - - media - - networking - - saas type: string path_affinity: description: "This parameter defines the path affinity characteristics to\ \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ \ \"strict\". If path affinity is none or weak and a better path is available,\ \ flows will be moved to a new path. If path affinity is strict, all application\ - \ flows will continue on the same path. \n" + \ flows will continue on the same path. \n" enum: - none - weak @@ -2440,7 +2255,14 @@ components: description: 'Application session timeout should be in between 0-44000. ' + format: int32 type: integer + system_app_overridden: + description: 'If true, it indicates the an application override has been + added. + + ' + type: boolean tags: description: 'A information field that can be added to identify the application. Maximum 10 Unique tags of length 1024 each are allowed. @@ -2456,7 +2278,7 @@ components: ' items: - $ref: '#/components/schemas/TcpRuleV2' + type: string type: array transfer_type: description: "Application transfer type. Allowed values: transactional,\ @@ -2468,7 +2290,7 @@ components: ' items: - $ref: '#/components/schemas/UdpRuleV2' + type: object type: array use_parentapp_network_policy: description: 'If enabled, policy rule defined for the parent application @@ -2476,585 +2298,3355 @@ components: ' type: boolean - BulkResponse: - properties: - count: - description: 'The total number. - - ' - format: int32 - type: integer - id: - description: 'The ID. - - ' - type: string - type: - description: "The type. \n" - type: string - DSCP: - properties: - value: - description: 'The DSCP value. - - ' - format: int32 - type: integer - Error: - properties: - _error: - items: - $ref: '#/components/schemas/ErrorResponse' - type: array - ErrorResponse: + required: + - app_type + - transfer_type + - display_name + - ingress_traffic_pct + - path_affinity + AppDefV2N4: properties: - code: - description: 'The error code. - - ' - type: string - message: - description: 'The error message. + abbreviation: + description: 'Abbreviation of the application name. ' type: string - Filter: - properties: - elements: - description: 'Elements of the filter. - - ' - items: - description: Elements - type: string - type: array - path: - description: 'Path of the filter. - - ' - items: - description: Path - type: string - type: array - site: - description: 'Site of the filter. + aggregate_flows: + description: 'The aggregate flows. ' - type: object - type: - description: 'Type of the filter. + type: boolean + app_type: + description: 'Type of application. Allowed values: custom. System defined + applications are not allowed to be edited using appdefs. ' type: string - GlobalPrefixFilter: - properties: - description: - description: 'Description for the global prefix filter. - - ' - filters: - description: 'List the filters. + app_unreachability_detection: + description: 'Application unreachability detection. ' - items: - $ref: '#/components/schemas/Filter' - type: array - id: - description: 'ID of the global prefix filter. - - ' - type: string - name: - description: 'Name of the global prefix filters. + type: boolean + category: + description: 'The application category. ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default type: string - required: - - filters - - name - GlobalPrefixFilterScreen: - properties: - description: - description: 'Description for the global prefix filter. + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. ' - filters: - description: 'List the filters. + format: int32 + type: integer + description: + description: 'Description for the application. Max size = 256. ' - items: - $ref: '#/components/schemas/Filter' - type: array - id: - description: 'ID of the global prefix filter. + display_name: + description: 'This is the name of the application that is visible on the + Controller UI. Application display name is required and cannot be null. + Max size = 64. ' type: string - name: - description: 'Name of the global prefix filters. + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. ' - type: string - required: - - filters - - name - GlobalPrefixQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of global prefixes that match the query - parameters. + items: + description: Domains + type: string + type: array + id: + description: 'Application ID. ' - dest_page: - description: 'The destination page. + type: string + ingress_traffic_pct: + description: 'The app def ingress traffic. Application ingress traffic percentage + should be in between 1-99. ' format: int32 type: integer - getDeleted: - description: 'The number global prefixes deleted for a time frame. - - ' - type: boolean - group_by: - description: 'Group the global prefixs for the query. + ip_rules: + description: 'Applicable for L3/L4 applications. These are IP Prefix rules + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. ' items: - description: Group By - type: string + type: object type: array - id: - description: "Lists the global prefixes by ID. \n" - type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. + is_deprecated: + description: 'Deprecated application definitions. ' - format: int64 - type: integer - limit: - description: 'The query limit. + type: boolean + network_scan_application: + description: 'If true, it enables Network Scan App to designate custom applications + as network scan applications. ' + 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) ' 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. + overrides_allowed: + description: 'If true, this enables an update to be added using the appdef_overrides + API. ' type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. + p_category: + description: 'Parent app category. ' - format: int64 - type: integer - GlobalPrefixQueryFilter: - properties: - description: - description: 'The description of the security policy global prefix. Max - size = 256. + type: string + p_parent_id: + description: P Parent Id + type: string + p_sub_category: + description: 'Parent app sub-category. ' - id: - description: 'The ID of the security policy global prefix. + type: string + parent_id: + description: 'Parent app ID. ' type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the security policy global prefix. + path_affinity: + description: "This parameter defines the path affinity characteristics to\ + \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ + \ \"strict\". If path affinity is none or weak and a better path is available,\ + \ flows will be moved to a new path. If path affinity is strict, all application\ + \ flows will continue on the same path. \n" + enum: + - none + - weak + - strict + type: string + session_timeout: + description: 'Application session timeout should be in between 0-44000. ' - items: - description: Ipv4 Prefixes - type: string - type: array - name: - description: 'The name of the security policy global prefix. Max size = - 128. + format: int32 + type: integer + supported_engines: + description: 'Supported engines. ' + enum: + - ave + - ave-all + - panos + - all type: string + system_app_overridden: + description: 'If true, it indicates the an application override has been + added. + + ' + type: boolean 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 application. + Maximum 10 Unique tags of length 1024 each are allowed. ' items: description: Tags type: string type: array - required: - - name - IPRuleV2: - properties: - dest_filters: - description: 'The app def destination filter list. Max size = 8. + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. ' items: - description: Dest Filters - type: string - type: array - dest_prefixes: - description: "The app def destination prefix filter list. Max size = 8.\ - \ \n" - items: - description: Dest Prefixes type: string type: array - dscp: - $ref: '#/components/schemas/DSCP' - description: 'The DSP value. + transfer_type: + description: "Application transfer type. Allowed values: transactional,\ + \ bulk, rt-audio, rt-video. \n" + type: string + udp_rules: + description: 'For UDP applications, this dictionary will include information + on UDP port, DCSP settings, UDP Filters and destination prefixes. ' - protocol: - description: 'The app def protocols. + items: + type: object + type: array + use_parentapp_network_policy: + description: 'If enabled, policy rule defined for the parent application + will be used to make routing decisions for this app. ' - enum: - - ospf - - ipv6 - - is-is-over-ipv4 - - ipv6-nonxt - - etherip - - ipv6-icmp - - igmp - - udplite - - ipv6-opts - - icmp - - esp - - crtp - - ipip - - eigrp - - egp - - gre - - l2tpv3 - - sctp - - ip-in-ip - - rsvp - - pim - - scps - - mpls-in-ip - - ah - - vrrp - - ipv6-route - - igp - - ipv6-frag - type: string - src_filters: - description: "The app def src filters list. Max size = 8. \n" - items: - description: Src Filters - type: string - type: array + type: boolean required: - - protocol - ListQueryResponse: + - app_type + - transfer_type + - display_name + - ingress_traffic_pct + - path_affinity + AppdefOverride: properties: - count: - description: 'The actual count. + aggregate_flows: + description: Aggregate Flows + type: boolean + category: + description: 'Category: ValidateEnum(enumClass = classOf[AppCategory], error + = APPDEF_CONFIG_INVALID_CATEGORY: Application category is invalid., nullAllowed + = true) ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default + type: string + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. ' - format: int32 type: integer - deleted_count: - description: 'The deleted number. + description: + description: 'Description for the application. Max size = 256. ' - format: int64 - type: integer - deleted_ids: - description: 'The deleted IDs. + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. ' items: + description: Domains 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. + description: 'Application ID. ' type: string - total_count: - description: 'Total number. - - ' - format: int64 + 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) ' type: integer - type: object - LocalPrefixFilter: - properties: - description: - description: 'Description of the local prefix filter. - - ' - id: - description: 'Id of the local prefix filter. + ip_rules: + description: 'Applicable for L3/L4 applications. These are IP Prefix rules + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. ' - type: string - name: - description: 'Name of the local prefix filter. + items: + $ref: '#/components/schemas/IPRuleV1' + type: array + override_default_ip_rules: + description: 'The default override IP rules. ' - type: string - required: - - name - LocalPrefixFilterScreen: - properties: - description: - description: 'Description of the local prefix filter. + type: boolean + override_default_tcp_rules: + description: 'The default override TCP rules. ' - id: - description: 'ID of the local prefix filter. + type: boolean + override_default_udp_rules: + description: 'The default override UDP rules. ' - type: string - name: - description: 'Name of the local prefix filter. + type: boolean + override_domains: + description: Override Domains + type: boolean + overrides_disable: + description: Overrides Disable + type: boolean + path_affinity: + description: 'This parameter defines the path affinity characteristics to + consider during flow decision making. Allowed values: "none" "weak" "strict". + If path affinity is none or weak and a better path is available, flows + will be moved to a new path. If path affinity is strict, all application + flows will continue on the same path. ' + enum: + - none + - weak + - strict type: string - required: - - name - LocalPrefixQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of app defs that match the query parameters. - - ' - dest_page: - description: 'The destination page. + session_timeout: + description: 'Application session timeout should be in between 0-44000. ' - format: int32 type: integer - getDeleted: - description: 'The number app definitions deleted for a time frame. - - ' - type: boolean - group_by: - description: 'Group the app definitions for the query. + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. ' items: - description: Group By + description: Tags 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. + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. ' - format: int32 - type: integer - next_query: - description: 'List the next query. + items: + $ref: '#/components/schemas/TcpRuleV1' + type: array + transfer_type: + description: 'Application transfer type. Allowed values: transactional, + bulk, rt-audio, rt-video. ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. + type: string + udp_rules: + description: 'For UDP applications, this dictionary will include information + on UDP port, DCSP settings, UDP Filters and destination prefixes. ' items: - description: Retrieved Fields - type: string + $ref: '#/components/schemas/UdpRuleV1' type: array - retrieved_fields_mask: - description: 'List the marked fields to query. - - ' + AppdefOverrideScreen: + properties: + aggregate_flows: + description: Aggregate Flows type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. + category: + description: 'Category: ValidateEnum(enumClass = classOf[AppCategory], error + = APPDEF_CONFIG_INVALID_CATEGORY: Application category is invalid., nullAllowed + = true) ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default + type: string + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. ' - format: int64 type: integer - Port: - properties: - end: - description: 'The end port range must be between 1 and 65535. - - ' - type: string - start: - description: 'The start port range must be between 1 and 65535. + description: + description: 'Description for the application. Max size = 256. ' - type: string - TcpRule: - properties: - client_filters: - description: 'The app def config IP list. Max size = 8. + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. ' items: - description: Client Filters + description: Domains type: string type: array - client_port: - $ref: '#/components/schemas/Port' - description: 'The start and end client port ranges. + id: + description: 'Application ID. ' - server_filters: - description: 'The app def config IP list. Max size = 8. + 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) ' + type: integer + ip_rules: + description: 'Applicable for L3/L4 applications. These are IP Prefix rules + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. ' items: - description: Server Filters - type: string + $ref: '#/components/schemas/IPRuleV1' type: array - server_port: - $ref: '#/components/schemas/Port' - description: 'The start and end server port ranges. + override_default_ip_rules: + description: 'The default override IP rules. ' - TcpRuleV2: - properties: - client_filters: - description: 'The app def config IP list. Max size = 8. + type: boolean + override_default_tcp_rules: + description: 'The default override TCP rules. ' - items: - description: Client Filters - type: string - type: array - client_port: - $ref: '#/components/schemas/Port' - description: 'The start and end client port ranges. + type: boolean + override_default_udp_rules: + description: 'The default override UDP rules. ' - dscp: - $ref: '#/components/schemas/DSCP' - description: 'The DSP value. + type: boolean + override_domains: + description: Override Domains + type: boolean + overrides_disable: + description: Overrides Disable + type: boolean + path_affinity: + description: 'This parameter defines the path affinity characteristics to + consider during flow decision making. Allowed values: "none" "weak" "strict". + If path affinity is none or weak and a better path is available, flows + will be moved to a new path. If path affinity is strict, all application + flows will continue on the same path. ' - server_filters: - description: 'The app def config IP list. Max size = 8. + enum: + - none + - weak + - strict + type: string + session_timeout: + description: 'Application session timeout should be in between 0-44000. + + ' + type: integer + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. ' items: - description: Server Filters + description: Tags type: string type: array - server_port: - $ref: '#/components/schemas/Port' - description: 'The start and end server port ranges. - - ' - server_prefixes: - description: 'The server prefixes. + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. ' items: - description: Server Prefixes - type: string + $ref: '#/components/schemas/TcpRuleV1' type: array - UdpRule: - properties: - udp_filters: - description: 'The app def config IP list. Max size = 8. + transfer_type: + 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 + on UDP port, DCSP settings, UDP Filters and destination prefixes. ' items: - description: Udp Filters - type: string + $ref: '#/components/schemas/UdpRuleV1' type: array - udp_port: - $ref: '#/components/schemas/Port' - description: "The start and end UDP port ranges. \n" - UdpRuleV2: + AppdefOverrideScreenV2N1: properties: - dest_prefixes: - description: 'The app def destination prefix filter list. Max size = 8. + aggregate_flows: + description: Aggregate Flows + type: boolean + app_unreachability_detection: + description: App Unreachability Detection + type: boolean + category: + description: 'Application category. Allowed values: ""anonymity"" ""anti-virus"" + ""auth"" ""backup"" ""cad"" ""collaboration"" ""conference"" ""crm"" ""db-mgmt"" + ""email"" ""enterprise"" ""file-sharing"" ""file-system"" ""file-transfer"" + ""gaming"" ""intercomm"" ""logging"" ""management"" ""messaging"" ""net-discovery"" + ""net-mgmt"" ""net-monitor"" ""news-server"" ""notification"" ""p2p"" + ""printing"" ""proxy"" ""recreational"" ""remote-desk"" ""remote-mgmt"" + ""replication"" ""routing"" ""saas"" ""secure-browsing"" ""storage"" ""streaming"" + ""tunnel"" ""utility"" ""voip"" ""wan-opt"" ""web-browsing"" ""wireless-mgmt"" + ""ip-protocol"" ""multicast"" ""security"" ""i23v5"" ""printer"" ""default""" ' - items: - description: Dest Prefixes - type: string - type: array - dscp: - $ref: '#/components/schemas/DSCP' - description: 'The DSP value. + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default + type: string + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. ' - udp_filters: - description: 'The app def config IP list. Max size = 8. + type: integer + description: + description: 'Description for the application. Max size = 256. + + ' + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. ' items: - description: Udp Filters + description: Domains type: string type: array - udp_port: - $ref: '#/components/schemas/Port' - description: 'The start and end UDP port ranges. - + id: + description: 'Application ID. + ' -info: - contact: {} - description: List of APIs used to manage an application definition specific query, - overrides, and version information. - title: Applications Definitions - version: Latest -openapi: 3.0.0 -paths: - /v2.0/api/tenants/{tenant_id}/appdefs_version: + 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) ' + type: integer + ip_rules: + description: 'Applicable for L3/L4 applications. These are IP Prefix rules + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. + + ' + items: + $ref: '#/components/schemas/IPRuleV1' + type: array + override_default_ip_rules: + description: 'List the override default IP rules. + + ' + type: boolean + override_default_tcp_rules: + description: 'List the override default TCP rules. + + ' + type: boolean + override_default_udp_rules: + description: 'List the override default UDP rules. + + ' + type: boolean + override_domains: + description: 'List the override domains. + + ' + type: boolean + overrides_disable: + description: 'List the disabled overrides. + + ' + type: boolean + path_affinity: + description: 'This parameter defines the path affinity characteristics to + consider during flow decision making. Allowed values: "none" "weak" "strict". + If path affinity is none or weak and a better path is available, flows + will be moved to a new path. If path affinity is strict, all application + flows will continue on the same path. + + ' + enum: + - none + - weak + - strict + type: string + session_timeout: + description: '' + type: integer + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. + + ' + items: + $ref: '#/components/schemas/TcpRuleV1' + type: array + transfer_type: + description: 'Application transfer type. Allowed values: transactional, + bulk, rt-audio, rt-video. + + ' + type: string + udp_rules: + description: "Application category. Allowed values: \"\"anonymity\"\" \"\ + \"anti-virus\"\" \"\"auth\"\" \"\"backup\"\" \"\"cad\"\" \"\"collaboration\"\ + \" \"\"conference\"\" \"\"crm\"\" \"\"db-mgmt\"\" \"\"email\"\" \"\"enterprise\"\ + \" \"\"file-sharing\"\" \"\"file-system\"\" \"\"file-transfer\"\" \"\"\ + gaming\"\" \"\"intercomm\"\" \"\"logging\"\" \"\"management\"\" \"\"messaging\"\ + \" \"\"net-discovery\"\" \"\"net-mgmt\"\" \"\"net-monitor\"\" \"\"news-server\"\ + \" \"\"notification\"\" \"\"p2p\"\" \"\"printing\"\" \"\"proxy\"\" \"\"\ + recreational\"\" \"\"remote-desk\"\" \"\"remote-mgmt\"\" \"\"replication\"\ + \" \"\"routing\"\" \"\"saas\"\" \"\"secure-browsing\"\" \"\"storage\"\"\ + \ \"\"streaming\"\" \"\"tunnel\"\" \"\"utility\"\" \"\"voip\"\" \"\"wan-opt\"\ + \" \"\"web-browsing\"\" \"\"wireless-mgmt\"\" \"\"ip-protocol\"\" \"\"\ + multicast\"\" \"\"security\"\" \"\"i23v5\"\" \"\"printer\"\" \"\"default\"\ + \"\" \n" + items: + $ref: '#/components/schemas/UdpRuleV1' + type: array + use_parentapp_network_policy: + description: 'If enabled, policy rule defined for the parent application + will be used to make routing decisions for this app. + + ' + type: boolean + AppdefOverrideScreenV2N2: + properties: + aggregate_flows: + description: 'The aggregate flows. + + ' + type: boolean + app_unreachability_detection: + description: 'Application unreachability detection. + + ' + type: boolean + category: + description: 'The application category. + + ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default + type: string + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. + + ' + type: integer + description: + description: 'Description for the application. Max size = 256. + + ' + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. + + ' + items: + description: Domains + type: string + type: array + id: + description: 'Application ID. + + ' + type: string + ingress_traffic_pct: + description: 'The app def config ingress traffic pct values. (Min value + = 1, Max value = 99). + + ' + type: integer + ip_rules: + description: 'Applicable for L3/L4 applications. These are IP Prefix rules + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. + + ' + items: + $ref: '#/components/schemas/IPRuleV2' + type: array + override_default_ip_rules: + description: 'The default override IP rules. + + ' + type: boolean + override_default_tcp_rules: + description: 'The default override TCP rules. + + ' + type: boolean + override_default_udp_rules: + description: 'The default override UDP rules. + + ' + type: boolean + override_domains: + description: 'List the override domains. + + ' + type: boolean + overrides_disable: + description: 'List the disabled overrides. + + ' + type: boolean + path_affinity: + description: "This parameter defines the path affinity characteristics to\ + \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ + \ \"strict\". If path affinity is none or weak and a better path is available,\ + \ flows will be moved to a new path. If path affinity is strict, all application\ + \ flows will continue on the same path. \n" + enum: + - none + - weak + - strict + type: string + session_timeout: + description: 'Application session timeout should be in between 0-44000. + + ' + type: integer + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. + + ' + items: + $ref: '#/components/schemas/TcpRuleV2' + type: array + transfer_type: + description: "Application transfer type. Allowed values: transactional,\ + \ bulk, rt-audio, rt-video. \n" + type: string + udp_rules: + description: 'For UDP applications, this dictionary will include information + on UDP port, DCSP settings, UDP Filters and destination prefixes. + + ' + items: + $ref: '#/components/schemas/UdpRuleV2' + type: array + use_parentapp_network_policy: + description: 'If enabled, policy rule defined for the parent application + will be used to make routing decisions for this app. + + ' + type: boolean + AppdefOverrideScreenV2N3: + properties: + aggregate_flows: + description: 'The aggregate flows. + + ' + type: boolean + app_unreachability_detection: + description: 'Application unreachability detection. + + ' + type: boolean + category: + description: 'The application category. + + ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default + type: string + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. + + ' + type: integer + description: + description: 'Description for the application. Max size = 256. + + ' + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. + + ' + items: + description: Domains + type: string + type: array + id: + description: 'Application ID. + + ' + type: string + ingress_traffic_pct: + 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 + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. + + ' + items: + $ref: '#/components/schemas/IPRuleV2' + type: array + override_default_ip_rules: + description: 'The default override IP rules. + + ' + type: boolean + override_default_tcp_rules: + description: 'The default override TCP rules. + + ' + type: boolean + override_default_udp_rules: + description: 'The default override UDP rules. + + ' + type: boolean + override_domains: + description: 'List the override domains. + + ' + type: boolean + overrides_disable: + description: 'List the disabled overrides. + + ' + type: boolean + p_category: + description: 'Parent App Category. + + ' + enum: + - business-systems + - collaboration + - general-internet + - media + - networking + - saas + type: string + path_affinity: + description: "This parameter defines the path affinity characteristics to\ + \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ + \ \"strict\". If path affinity is none or weak and a better path is available,\ + \ flows will be moved to a new path. If path affinity is strict, all application\ + \ flows will continue on the same path. \n" + enum: + - none + - weak + - strict + type: string + session_timeout: + description: 'Application session timeout should be in between 0-44000. + + ' + type: integer + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. + + ' + items: + $ref: '#/components/schemas/TcpRuleV2' + type: array + transfer_type: + description: "Application transfer type. Allowed values: transactional,\ + \ bulk, rt-audio, rt-video. \n" + type: string + udp_rules: + description: 'For UDP applications, this dictionary will include information + on UDP port, DCSP settings, UDP Filters and destination prefixes. + + ' + items: + $ref: '#/components/schemas/UdpRuleV2' + type: array + use_parentapp_network_policy: + description: 'If enabled, policy rule defined for the parent application + will be used to make routing decisions for this app. + + ' + type: boolean + AppdefOverrideV2N1: + properties: + aggregate_flows: + description: Aggregate Flows + type: boolean + app_unreachability_detection: + description: App Unreachability Detection + type: boolean + category: + description: 'Category: ValidateEnum(enumClass = classOf[AppCategory], error + = APPDEF_CONFIG_INVALID_CATEGORY: Application category is invalid., nullAllowed + = true) ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default + type: string + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. + + ' + type: integer + description: + description: 'Description for the application. Max size = 256. + + ' + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. + + ' + items: + description: Domains + type: string + type: array + id: + description: 'Application ID. + + ' + 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) ' + type: integer + ip_rules: + description: 'Applicable for L3/L4 applications. These are IP Prefix rules + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. + + ' + items: + $ref: '#/components/schemas/IPRuleV1' + type: array + override_default_ip_rules: + description: 'List the override default IP rules. + + ' + type: boolean + override_default_tcp_rules: + description: 'List the override default TCP rules. + + ' + type: boolean + override_default_udp_rules: + description: 'List the override default UDP rules. + + ' + type: boolean + override_domains: + description: 'List the override domains. + + ' + type: boolean + overrides_disable: + description: 'List the disabled overrides. + + ' + type: boolean + path_affinity: + description: 'This parameter defines the path affinity characteristics to + consider during flow decision making. Allowed values: "none" "weak" "strict". + If path affinity is none or weak and a better path is available, flows + will be moved to a new path. If path affinity is strict, all application + flows will continue on the same path. + + ' + enum: + - none + - weak + - strict + type: string + session_timeout: + description: 'Application session timeout should be in between 0-44000. + + ' + type: integer + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. + + ' + items: + $ref: '#/components/schemas/TcpRuleV1' + type: array + transfer_type: + description: 'Application transfer type. Allowed values: transactional, + bulk, rt-audio, rt-video. + + ' + type: string + udp_rules: + description: "Application category. Allowed values: \"\"anonymity\"\" \"\ + \"anti-virus\"\" \"\"auth\"\" \"\"backup\"\" \"\"cad\"\" \"\"collaboration\"\ + \" \"\"conference\"\" \"\"crm\"\" \"\"db-mgmt\"\" \"\"email\"\" \"\"enterprise\"\ + \" \"\"file-sharing\"\" \"\"file-system\"\" \"\"file-transfer\"\" \"\"\ + gaming\"\" \"\"intercomm\"\" \"\"logging\"\" \"\"management\"\" \"\"messaging\"\ + \" \"\"net-discovery\"\" \"\"net-mgmt\"\" \"\"net-monitor\"\" \"\"news-server\"\ + \" \"\"notification\"\" \"\"p2p\"\" \"\"printing\"\" \"\"proxy\"\" \"\"\ + recreational\"\" \"\"remote-desk\"\" \"\"remote-mgmt\"\" \"\"replication\"\ + \" \"\"routing\"\" \"\"saas\"\" \"\"secure-browsing\"\" \"\"storage\"\"\ + \ \"\"streaming\"\" \"\"tunnel\"\" \"\"utility\"\" \"\"voip\"\" \"\"wan-opt\"\ + \" \"\"web-browsing\"\" \"\"wireless-mgmt\"\" \"\"ip-protocol\"\" \"\"\ + multicast\"\" \"\"security\"\" \"\"i23v5\"\" \"\"printer\"\" \"\"default\"\ + \"\" \n" + items: + $ref: '#/components/schemas/UdpRuleV1' + type: array + use_parentapp_network_policy: + description: 'If enabled, policy rule defined for the parent application + will be used to make routing decisions for this app. + + ' + type: boolean + AppdefOverrideV2N2: + properties: + aggregate_flows: + description: 'The aggregate flows. + + ' + type: boolean + app_unreachability_detection: + description: 'Application unreachability detection. + + ' + type: boolean + category: + description: 'The application category. + + ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default + type: string + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. + + ' + type: integer + description: + description: 'Description for the application. Max size = 256. + + ' + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. + + ' + items: + description: Domains + type: string + type: array + id: + description: 'Application ID. + + ' + type: string + ingress_traffic_pct: + 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 + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. + + ' + items: + $ref: '#/components/schemas/IPRuleV2' + type: array + override_default_ip_rules: + description: 'The default override IP rules. + + ' + type: boolean + override_default_tcp_rules: + description: 'The default override TCP rules. + + ' + type: boolean + override_default_udp_rules: + description: 'The default override UDP rules. + + ' + type: boolean + override_domains: + description: 'List the override domains. + + ' + type: boolean + overrides_disable: + description: 'List the disabled overrides. + + ' + type: boolean + path_affinity: + description: "This parameter defines the path affinity characteristics to\ + \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ + \ \"strict\". If path affinity is none or weak and a better path is available,\ + \ flows will be moved to a new path. If path affinity is strict, all application\ + \ flows will continue on the same path. \n" + enum: + - none + - weak + - strict + type: string + session_timeout: + description: 'Application session timeout should be in between 0-44000. + + ' + type: integer + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. + + ' + items: + $ref: '#/components/schemas/TcpRuleV2' + type: array + transfer_type: + description: "Application transfer type. Allowed values: transactional,\ + \ bulk, rt-audio, rt-video. \n" + type: string + udp_rules: + description: 'For UDP applications, this dictionary will include information + on UDP port, DCSP settings, UDP Filters and destination prefixes. + + ' + items: + $ref: '#/components/schemas/UdpRuleV2' + type: array + use_parentapp_network_policy: + description: 'If enabled, policy rule defined for the parent application + will be used to make routing decisions for this app. + + ' + type: boolean + AppdefOverrideV2N3: + properties: + aggregate_flows: + description: 'The aggregate flows. + + ' + type: boolean + app_unreachability_detection: + description: 'Application unreachability detection. + + ' + type: boolean + category: + description: 'The application category. + + ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default + type: string + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. + + ' + type: integer + description: + description: 'Description for the application. Max size = 256. + + ' + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. + + ' + items: + description: Domains + type: string + type: array + id: + description: 'Application ID. + + ' + type: string + ingress_traffic_pct: + 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 + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. + + ' + items: + $ref: '#/components/schemas/IPRuleV2' + type: array + override_default_ip_rules: + description: 'The default override IP rules. + + ' + type: boolean + override_default_tcp_rules: + description: 'The default override TCP rules. + + ' + type: boolean + override_default_udp_rules: + description: 'The default override UDP rules. + + ' + type: boolean + override_domains: + description: 'List the override domains. + + ' + type: boolean + overrides_disable: + description: 'List the disabled overrides. + + ' + type: boolean + p_category: + description: 'Parent App Category. + + ' + enum: + - business-systems + - collaboration + - general-internet + - media + - networking + - saas + type: string + path_affinity: + description: "This parameter defines the path affinity characteristics to\ + \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ + \ \"strict\". If path affinity is none or weak and a better path is available,\ + \ flows will be moved to a new path. If path affinity is strict, all application\ + \ flows will continue on the same path. \n" + enum: + - none + - weak + - strict + type: string + session_timeout: + description: 'Application session timeout should be in between 0-44000. + + ' + type: integer + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. + + ' + items: + $ref: '#/components/schemas/TcpRuleV2' + type: array + transfer_type: + description: "Application transfer type. Allowed values: transactional,\ + \ bulk, rt-audio, rt-video. \n" + type: string + udp_rules: + description: 'For UDP applications, this dictionary will include information + on UDP port, DCSP settings, UDP Filters and destination prefixes. + + ' + items: + $ref: '#/components/schemas/UdpRuleV2' + type: array + use_parentapp_network_policy: + description: 'If enabled, policy rule defined for the parent application + will be used to make routing decisions for this app. + + ' + type: boolean + BulkResponse: + properties: + count: + description: 'The total number. + + ' + format: int32 + type: integer + id: + description: 'The ID. + + ' + type: string + type: + description: "The type. \n" + type: string + DSCP: + properties: + value: + description: 'The DSCP value. + + ' + format: int32 + type: integer + Error: + properties: + _error: + items: + $ref: '#/components/schemas/ErrorResponse' + type: array + ErrorResponse: + properties: + code: + description: 'The error code. + + ' + type: string + message: + description: 'The error message. + + ' + type: string + Filter: + properties: + elements: + description: 'Elements of the filter. + + ' + items: + description: Elements + type: string + type: array + path: + description: 'Path of the filter. + + ' + items: + description: Path + type: string + type: array + site: + description: 'Site of the filter. + + ' + type: object + type: + description: 'Type of the filter. + + ' + type: string + required: + - path + - site + - elements + GlobalPrefixFilter: + properties: + description: + description: 'Description for the global prefix filter. + + ' + filters: + description: 'List the filters. + + ' + items: + $ref: '#/components/schemas/Filter' + type: array + id: + description: 'ID of the global prefix filter. + + ' + type: string + name: + description: 'Name of the global prefix filters. + + ' + type: string + required: + - filters + - name + GlobalPrefixFilterScreen: + properties: + description: + description: 'Description for the global prefix filter. + + ' + filters: + description: 'List the filters. + + ' + items: + $ref: '#/components/schemas/Filter' + type: array + id: + description: 'ID of the global prefix filter. + + ' + type: string + name: + description: 'Name of the global prefix filters. + + ' + type: string + required: + - filters + - name + GlobalPrefixQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of global prefixes that match the query + parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number global prefixes deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the global prefixs for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "Lists the global prefixes 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 + GlobalPrefixQueryFilter: + properties: + description: + description: 'The description of the security policy global prefix. Max + size = 256. + + ' + id: + description: 'The ID of the security policy global prefix. + + ' + type: string + ipv4_prefixes: + description: 'Lists the IPv4 addresses of the security policy global prefix. + + ' + items: + description: Ipv4 Prefixes + type: string + type: array + name: + description: 'The name of the security policy global prefix. Max size = + 128. + + ' + 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. + + ' + items: + description: Tags + type: string + type: array + required: + - name + IPRuleV1: + properties: + dest_filters: + description: 'Dest 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) ' + items: + description: Dest Filters + type: string + type: array + dscp: + $ref: '#/components/schemas/DSCP' + description: 'Dscp: Valid ' + protocol: + description: 'Protocol: ValidateEnum(enumClass = classOf[Protocol], error + = APPDEF_CONFIG_INVALID_PROTOCOL: Application protocol is invalid., nullAllowed + = false) ' + enum: + - ospf + - ipv6 + - is-is-over-ipv4 + - ipv6-nonxt + - etherip + - ipv6-icmp + - igmp + - udplite + - ipv6-opts + - icmp + - esp + - crtp + - ipip + - eigrp + - egp + - gre + - l2tpv3 + - sctp + - ip-in-ip + - rsvp + - pim + - scps + - mpls-in-ip + - ah + - vrrp + - ipv6-route + - igp + - ipv6-frag + type: string + src_filters: + description: 'Src 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) ' + items: + description: Src Filters + type: string + type: array + required: + - protocol + IPRuleV2: + properties: + dest_filters: + description: 'The app def destination filter list. Max size = 8. + + ' + items: + description: Dest Filters + type: string + type: array + dest_prefixes: + description: "The app def destination prefix filter list. Max size = 8.\ + \ \n" + items: + description: Dest Prefixes + type: string + type: array + dscp: + $ref: '#/components/schemas/DSCP' + description: 'The DSP value. + + ' + protocol: + description: 'The app def protocols. + + ' + enum: + - ospf + - ipv6 + - is-is-over-ipv4 + - ipv6-nonxt + - etherip + - ipv6-icmp + - igmp + - udplite + - ipv6-opts + - icmp + - esp + - crtp + - ipip + - eigrp + - egp + - gre + - l2tpv3 + - sctp + - ip-in-ip + - rsvp + - pim + - scps + - mpls-in-ip + - ah + - vrrp + - ipv6-route + - igp + - ipv6-frag + type: string + src_filters: + description: "The app def src filters list. Max size = 8. \n" + items: + description: Src Filters + type: string + type: array + required: + - protocol + 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 + LocalPrefixFilter: + properties: + description: + description: 'Description of the local prefix filter. + + ' + id: + description: 'Id of the local prefix filter. + + ' + type: string + name: + description: 'Name of the local prefix filter. + + ' + type: string + required: + - name + LocalPrefixFilterScreen: + properties: + description: + description: 'Description of the local prefix filter. + + ' + id: + description: 'ID of the local prefix filter. + + ' + type: string + name: + description: 'Name of the local prefix filter. + + ' + type: string + required: + - name + LocalPrefixQuery: + 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 the app definitions for the query. + + ' + 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: 'List the next query. + + ' + 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 marked fields to query. + + ' + type: boolean + sort_params: + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + Port: + properties: + end: + description: 'The end port range must be between 1 and 65535. + + ' + type: string + start: + description: 'The start port range must be between 1 and 65535. + + ' + type: string + TcpRule: + properties: + client_filters: + 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: 'The start and end client port ranges. + + ' + server_filters: + 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: 'The start and end server port ranges. + + ' + TcpRuleV1: + 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) ' + items: + description: Client Filters + type: string + type: array + client_port: + $ref: '#/components/schemas/Port' + description: 'Client Port: Valid ' + dscp: + $ref: '#/components/schemas/DSCP' + description: 'Dscp: Valid ' + 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) ' + items: + description: Server Filters + type: string + type: array + server_port: + $ref: '#/components/schemas/Port' + description: 'Server Port: Valid ' + TcpRuleV2: + properties: + client_filters: + 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: 'The start and end client port ranges. + + ' + dscp: + $ref: '#/components/schemas/DSCP' + description: 'The DSP value. + + ' + server_filters: + 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: 'The start and end server port ranges. + + ' + server_prefixes: + description: 'The server prefixes. + + ' + items: + description: Server Prefixes + type: string + type: array + UdpRule: + properties: + udp_filters: + 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: "The start and end UDP port ranges. \n" + UdpRuleV1: + properties: + dscp: + $ref: '#/components/schemas/DSCP' + description: 'Dscp: Valid ' + 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) ' + items: + description: Udp Filters + type: string + type: array + udp_port: + $ref: '#/components/schemas/Port' + description: 'Udp Port: Valid ' + UdpRuleV2: + properties: + dest_prefixes: + description: 'The app def destination prefix filter list. Max size = 8. + + ' + items: + description: Dest Prefixes + type: string + type: array + dscp: + $ref: '#/components/schemas/DSCP' + description: 'The DSP value. + + ' + udp_filters: + 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: 'The start and end UDP port ranges. + + ' +info: + contact: {} + description: List of APIs used to manage an application definition specific query, + overrides, and version information. + title: Applications Definitions + version: Latest +openapi: 3.0.0 +paths: + /v2.0/api/tenants/{tenant_id}/appdefs: + get: + description: Get all application definitions + operationId: get-v2.0-api-tenants-tenant_id-appdefs + parameters: + - description: 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/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AppDefV2' + type: array + type: object + description: Successful Operation + summary: Get all application definitions (v2.0) + tags: + - Applications + post: + description: Create a custom application definition. + operationId: post-v2.0-api-tenants-tenant_id-appdefs + 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/AppDefScreenV2' + description: Application definition + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefV2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_INVALID_TYPE + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Custom Application Definition (2.0) + tags: + - Applications + /v2.0/api/tenants/{tenant_id}/appdefs/query: + post: + description: Queries db for limit number of app defs that match query params. + operationId: post-v2.0-api-tenants-tenant_id-appdefs-query + 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/AppDefQuery' + description: Query Details for the app def + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AppDefQueryFilterTransformed' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: GENERAL_CONFIG_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Queries db for limit number of app defs that match query params. (v2.0) + tags: + - Applications + /v2.0/api/tenants/{tenant_id}/appdefs/{appdef_id}: + delete: + description: Delete a custom application definition + operationId: delete-v2.0-api-tenants-tenant_id-appdefs-appdef_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Application definition Id + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefV2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_APP_NOT_FOUND + - code: APPDEF_CONFIG_INVALID_APP + - code: APPDEF_CONFIG_APP_IN_USE + - code: APPLICATION_IS_USED_IN_IPFIX_PROFILE + - code: APPLICATION_IS_USED_IN_IPFIX_CONFIG + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete a custom application definition (v2.0) + tags: + - Applications + get: + description: Get application definition + operationId: get-v2.0-api-tenants-tenant_id-appdefs-appdef_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Application Id + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefV2' + description: Successful Operation + summary: Get application definition (v2.0) + tags: + - Applications + put: + description: Change standard apps version + operationId: put-v2.0-api-tenants-tenant_id-appdefs-appdef_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Appdef Id + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefTenantVersion' + description: Details of the app def tenant version to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefTenantVersion' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: GENERAL_CONFIG_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Change standard apps version (v2.0) + tags: + - Applications + /v2.0/api/tenants/{tenant_id}/appdefs/{appdef_id}/overrides: + get: + description: Get application definition overrides for system appdef + operationId: get-v2.0-api-tenants-tenant_id-appdefs-appdef_id-overrides + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Application definition Id + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverride' + description: Successful Operation + summary: Get application definition overrides for system appdef (v2.0) + tags: + - Applications + post: + description: Create a application definition overrides for system appdef + operationId: post-v2.0-api-tenants-tenant_id-appdefs-appdef_id-overrides + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Application definition Id + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverrideScreen' + description: Application definition Override + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverride' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_INVALID_SYSTEM_APPS + - code: APPDEF_CONFIG_APP_NOT_EXISTS + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_DEPRECATED_APP + - code: APPDEF_CONFIG_INVALID_OVERRIDE_DOMAIN_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_TCP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_UDP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_IP_FLAG + - code: APPDEF_CONFIG_NOT_ALLOWED + - code: APPDEF_CONFIG_MISSING_UDP_PORTS + - code: APPDEF_CONFIG_MISSING_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_UDP_PORTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create a application definition overrides for system appdef (v2.0) + tags: + - Applications + /v2.0/api/tenants/{tenant_id}/appdefs/{appdef_id}/overrides/{override_id}: + delete: + description: Delete application definition overrides for system appdef + operationId: delete-v2.0-api-tenants-tenant_id-appdefs-appdef_id-overrides-override_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Application definition Id + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + - description: Override Id + in: path + name: override_id + required: true + schema: + description: Override Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverride' + description: Successful Operation + summary: Delete application definition overrides for system appdef (v2.0) + tags: + - Applications + get: + description: Get application definition overrides for system appdef + operationId: get-v2.0-api-tenants-tenant_id-appdefs-appdef_id-overrides-override_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Application definition Id + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + - description: Override Id + in: path + name: override_id + required: true + schema: + description: Override Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverride' + description: Successful Operation + summary: Get application definition overrides for system appdef (v2.0) + tags: + - Applications + put: + description: Update a application definition overrides for system appdef + operationId: put-v2.0-api-tenants-tenant_id-appdefs-appdef_id-overrides-override_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Application definition Id + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + - description: Appdef overrides Id + in: path + name: override_id + required: true + schema: + description: Override Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverrideScreen' + description: Application definition Override + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverride' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_APP_NOT_EXISTS + - code: APPDEF_CONFIG_INVALID_APPDEF_ID + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_DEPRECATED_APP + - code: APPDEF_CONFIG_INVALID_OVERRIDE_DOMAIN_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_TCP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_UDP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_IP_FLAG + - code: APPDEF_CONFIG_NOT_ALLOWED + - code: APPDEF_CONFIG_MISSING_UDP_PORTS + - code: APPDEF_CONFIG_MISSING_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_UDP_PORTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update a application definition overrides for system appdef (v2.0) + tags: + - Applications + /v2.0/api/tenants/{tenant_id}/appdefs_version: + get: + description: Get the application version for a tenant. + operationId: get-v2.0-api-tenants-tenant_id-appdefs_version + 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/AppDefTenantVersion' + description: Successful Operation + summary: Get Application Version for Tenant (v2.0) + tags: + - Applications + /v2.0/api/tenants/{tenant_id}/appdefs_version/{vid}: + get: + description: Get the system application definitions. + operationId: get-v2.0-api-tenants-tenant_id-appdefs_version-vid + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Version ID. + in: path + name: vid + required: true + schema: + description: Vid + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AppDefV2' + type: array + type: object + description: Successful Operation + summary: Get System Application Definitions (v2.0) + tags: + - Applications + put: + description: Change the standard app version. + operationId: put-v2.0-api-tenants-tenant_id-appdefs_version-vid + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Version ID. + in: path + name: vid + required: true + schema: + description: Vid + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefTenantVersion' + description: Details of the app def tenant version to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefTenantVersion' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: GENERAL_CONFIG_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Change Standard Apps Version (v2.0) + tags: + - Applications + /v2.0/api/tenants/{tenant_id}/globalprefixfilters: + get: + description: Get the global prefix filters. + operationId: get-v2.0-api-tenants-tenant_id-globalprefixfilters + 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/GlobalPrefixFilter' + description: Successful Operation + summary: Get Global Prefix Filters (v2.0) + tags: + - Applications + post: + description: Create a new global prefix filter. + operationId: post-v2.0-api-tenants-tenant_id-globalprefixfilters + 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/GlobalPrefixFilterScreen' + description: Details of the prefix filter to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalPrefixFilterScreen' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SECURITY_FILTER_DUPLICATE_FILTER + - code: SECURITY_FILTER_NAME_REQUIRED + - code: SECURITY_FILTER_INVALID_NAME + - code: SECURITY_FILTER_INVALID_DESCRIPTION + - code: JSON_SCHEMA_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create New Global Prefix Filter (v2.0) + tags: + - Applications + /v2.0/api/tenants/{tenant_id}/globalprefixfilters/query: + post: + description: Lists the query details for the list of parameters for global prefix + filters. + operationId: post-v2.0-api-tenants-tenant_id-globalprefixfilters-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/GlobalPrefixQuery' + description: Query Details for GlobalPrefixFilter + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/GlobalPrefixQueryFilter' + 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 List of Global Prefix Filters(v2.0) + tags: + - Applications + /v2.0/api/tenants/{tenant_id}/globalprefixfilters/{filter_id}: + delete: + description: Delete a specific global prefix filter. + operationId: delete-v2.0-api-tenants-tenant_id-globalprefixfilters-filter_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the global prefix filter. + in: path + name: filter_id + required: true + schema: + description: Filter Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalPrefixFilter' + description: Successful Operation + summary: Delete Global Prefix Filter (v2.0) + tags: + - Applications + get: + description: Get a specific global prefix filter. + operationId: get-v2.0-api-tenants-tenant_id-globalprefixfilters-filter_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the global prefix filter. + in: path + name: filter_id + required: true + schema: + description: Filter Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalPrefixFilter' + description: Successful Operation + summary: Get Specific Global Prefix Filter (v2.0) + tags: + - Applications + put: + description: Update a new global prefix filter. + operationId: put-v2.0-api-tenants-tenant_id-globalprefixfilters-filter_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the new global prefix filter. + in: path + name: filter_id + required: true + schema: + description: Filter Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalPrefixFilterScreen' + description: Details to update the global prefix filter. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalPrefixFilterScreen' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SECURITY_FILTER_DUPLICATE_FILTER + - code: SECURITY_FILTER_NAME_REQUIRED + - code: SECURITY_FILTER_INVALID_NAME + - code: SECURITY_FILTER_INVALID_DESCRIPTION + - code: JSON_SCHEMA_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Global Prefix Filter (v2.0) + tags: + - Applications + /v2.0/api/tenants/{tenant_id}/localprefixfilters: + get: + description: Get the local prefix filters. + operationId: get-v2.0-api-tenants-tenant_id-localprefixfilters + 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/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/LocalPrefixFilter' + type: array + type: object + description: Successful Operation + summary: Get Local Prefix Filters (v2.0) + tags: + - Applications + post: + description: Create a new local prefix filter. + operationId: post-v2.0-api-tenants-tenant_id-localprefixfilters + 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/LocalPrefixFilterScreen' + description: Details of the prefix filter to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LocalPrefixFilter' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SECURITY_FILTER_DUPLICATE_FILTER + - code: SECURITY_FILTER_NAME_REQUIRED + - code: SECURITY_FILTER_INVALID_NAME + - code: SECURITY_FILTER_INVALID_DESCRIPTION + - code: JSON_SCHEMA_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create New Local Prefix Filter (v2.0) + tags: + - Applications + /v2.0/api/tenants/{tenant_id}/localprefixfilters/query: + post: + description: Lists the query details for the list of parameters for local prefix + filters. + operationId: post-v2.0-api-tenants-tenant_id-localprefixfilters-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/LocalPrefixQuery' + description: Query Details for Local Prefix Filter + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/LocalPrefixFilter' + 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 Local Prefix Filters (v2.0) + tags: + - Applications + /v2.0/api/tenants/{tenant_id}/localprefixfilters/{id}: + delete: + description: Delete a specific local prefix filter. + operationId: delete-v2.0-api-tenants-tenant_id-localprefixfilters-id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the local prefix filter. + in: path + name: id + required: true + schema: + description: Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LocalPrefixFilter' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: PREFIXFILTER_NAME_REQUIRED + - code: PREFIXFILTER_INVALID_DESCRIPTION + - code: PREFIXFILTER_INVALID_NAME + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Local Prefix Filter (v2.0) + tags: + - Applications get: - description: Get the application version for a tenant. - operationId: get-v2.0-api-tenants-tenant_id-appdefs_version + description: Get a specific global prefix filter. + operationId: get-v2.0-api-tenants-tenant_id-localprefixfilters-id parameters: - description: The tenant ID. in: path @@ -3063,20 +5655,26 @@ paths: schema: description: Tenant Id type: string + - description: The ID of the local prefix filter. + in: path + name: id + required: true + schema: + description: Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/AppDefTenantVersion' + $ref: '#/components/schemas/LocalPrefixFilter' description: Successful Operation - summary: Get Application Version for Tenant (v2.0) + summary: Get Specific Local Prefix Filter (v2.0) tags: - Applications - /v2.0/api/tenants/{tenant_id}/appdefs_version/{vid}: - get: - description: Get the system application definitions. - operationId: get-v2.0-api-tenants-tenant_id-appdefs_version-vid + put: + description: Update a new local prefix filter. + operationId: put-v2.0-api-tenants-tenant_id-localprefixfilters-id parameters: - description: The tenant ID. in: path @@ -3085,12 +5683,54 @@ paths: schema: description: Tenant Id type: string - - description: Version ID. + - description: The ID of the new local prefix filter. in: path - name: vid + name: id required: true schema: - description: Vid + description: Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LocalPrefixFilterScreen' + description: Details to update the local prefix filter. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LocalPrefixFilterScreen' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SECURITY_FILTER_DUPLICATE_FILTER + - code: SECURITY_FILTER_NAME_REQUIRED + - code: SECURITY_FILTER_INVALID_NAME + - code: SECURITY_FILTER_INVALID_DESCRIPTION + - code: JSON_SCHEMA_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Local Prefix Filter (v2.0) + tags: + - Applications + /v2.1/api/tenants/{tenant_id}/appdefs: + get: + description: Get all application definitions + operationId: get-v2.1-api-tenants-tenant_id-appdefs + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string responses: '200': @@ -3102,16 +5742,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/AppDefV2' + $ref: '#/components/schemas/AppDefV2N1' type: array type: object description: Successful Operation - summary: Get System Application Definitions (v2.0) + summary: Get all application definitions (v2.1) tags: - Applications - put: - description: Change the standard app version. - operationId: put-v2.0-api-tenants-tenant_id-appdefs_version-vid + post: + description: Create an application definition. + operationId: post-v2.1-api-tenants-tenant_id-appdefs parameters: - description: The tenant ID. in: path @@ -3120,25 +5760,76 @@ paths: schema: description: Tenant Id type: string - - description: Version ID. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefScreenV2N1' + description: Application definition + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_UPDATING_READ_ONLY_FIELD + - code: APPDEF_CONFIG_INVALID_TYPE + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_ORDER_NUMBER + - code: APPDEF_CONFIG_INVALID_ORDER_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Application Definition (v2.1) + tags: + - Applications + /v2.1/api/tenants/{tenant_id}/appdefs/query: + post: + description: Queries db for limit number of app defs that match query params. + operationId: post-v2.1-api-tenants-tenant_id-appdefs-query + parameters: + - description: Tenant Id in: path - name: vid + name: tenant_id required: true schema: - description: Vid + description: Tenant Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/AppDefTenantVersion' - description: Details of the app def tenant version to be created + $ref: '#/components/schemas/AppDefQuery' + description: Query Details for the app def responses: '200': content: application/json: schema: - $ref: '#/components/schemas/AppDefTenantVersion' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AppDefQueryFilterTransformed' + type: array + type: object description: Successful Operation '400': content: @@ -3150,104 +5841,197 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Change Standard Apps Version (v2.0) + summary: Queries db for limit number of app defs that match query params. (v2.1) + tags: + - Applications + /v2.1/api/tenants/{tenant_id}/appdefs/{appdef_id}: + delete: + description: Delete a application definition + operationId: delete-v2.1-api-tenants-tenant_id-appdefs-appdef_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Application definition Id + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_INVALID_APP + - code: APPDEF_CONFIG_APP_IN_USE + - code: APPLICATION_IS_USED_IN_IPFIX_PROFILE + - code: APPLICATION_IS_USED_IN_IPFIX_CONFIG + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete a application definition (v2.1) + tags: + - Applications + get: + description: Get application definition + operationId: get-v2.1-api-tenants-tenant_id-appdefs-appdef_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Application definition Id + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefV2N1' + description: Successful Operation + summary: Get application definition (v2.1) + tags: + - Applications + put: + description: Update a application definition + operationId: put-v2.1-api-tenants-tenant_id-appdefs-appdef_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Application definition Id + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefScreenV2N1' + description: Application definition + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_UPDATING_READ_ONLY_FIELD + - code: APPDEF_CONFIG_INVALID_TYPE + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_ORDER_NUMBER + - code: APPDEF_CONFIG_INVALID_ORDER_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_UDP_PORTS + - code: APPDEF_CONFIG_DEPRECATED_APP + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update a application definition (v2.1) tags: - Applications - /v2.0/api/tenants/{tenant_id}/globalprefixfilters: + /v2.1/api/tenants/{tenant_id}/appdefs/{appdef_id}/overrides: get: - description: Get the global prefix filters. - operationId: get-v2.0-api-tenants-tenant_id-globalprefixfilters + description: Get application definition overrides for system appdef + operationId: get-v2.1-api-tenants-tenant_id-appdefs-appdef_id-overrides parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/GlobalPrefixFilter' - description: Successful Operation - summary: Get Global Prefix Filters (v2.0) - tags: - - Applications - post: - description: Create a new global prefix filter. - operationId: post-v2.0-api-tenants-tenant_id-globalprefixfilters - parameters: - - description: The tenant ID. + - description: Application definition Id in: path - name: tenant_id + name: appdef_id required: true schema: - description: Tenant Id + description: Appdef Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GlobalPrefixFilterScreen' - description: Details of the prefix filter to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/GlobalPrefixFilterScreen' + $ref: '#/components/schemas/AppdefOverrideV2N1' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SECURITY_FILTER_DUPLICATE_FILTER - - code: SECURITY_FILTER_NAME_REQUIRED - - code: SECURITY_FILTER_INVALID_NAME - - code: SECURITY_FILTER_INVALID_DESCRIPTION - - code: JSON_SCHEMA_MISMATCH - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create New Global Prefix Filter (v2.0) + summary: Get application definition overrides for system appdef (v2.1) tags: - Applications - /v2.0/api/tenants/{tenant_id}/globalprefixfilters/query: post: - description: Lists the query details for the list of parameters for global prefix - filters. - operationId: post-v2.0-api-tenants-tenant_id-globalprefixfilters-query + description: Create a application definition overrides for system appdef + operationId: post-v2.1-api-tenants-tenant_id-appdefs-appdef_id-overrides parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string + - description: Application definition Id + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/GlobalPrefixQuery' - description: Query Details for GlobalPrefixFilter + $ref: '#/components/schemas/AppdefOverrideScreenV2N1' + description: Application definition Override responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/GlobalPrefixQueryFilter' - type: array - type: object + $ref: '#/components/schemas/AppdefOverrideV2N1' description: Successful Operation '400': content: @@ -3255,100 +6039,143 @@ paths: example: value: _error: - - code: BAD_QUERY_REQUEST + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_INVALID_SYSTEM_APPS + - code: APPDEF_CONFIG_APP_NOT_EXISTS + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_DEPRECATED_APP + - code: APPDEF_CONFIG_INVALID_OVERRIDE_DOMAIN_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_TCP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_UDP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_IP_FLAG + - code: APPDEF_CONFIG_NOT_ALLOWED + - code: APPDEF_CONFIG_MISSING_UDP_PORTS + - code: APPDEF_CONFIG_MISSING_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_UDP_PORTS + - code: APPDEF_CONFIG_READ_ONLY_USE_PARENTAPP_NETWORK_POLICY + - code: APPDEF_CONFIG_READ_ONLY_APP_UNREACHABILITY_DETECTION schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for List of Global Prefix Filters(v2.0) + summary: Create a application definition overrides for system appdef (v2.1) tags: - Applications - /v2.0/api/tenants/{tenant_id}/globalprefixfilters/{filter_id}: + /v2.1/api/tenants/{tenant_id}/appdefs/{appdef_id}/overrides/{override_id}: delete: - description: Delete a specific global prefix filter. - operationId: delete-v2.0-api-tenants-tenant_id-globalprefixfilters-filter_id + description: Delete application definition overrides for system appdef + operationId: delete-v2.1-api-tenants-tenant_id-appdefs-appdef_id-overrides-override_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the global prefix filter. + - description: Application definition Id in: path - name: filter_id + name: appdef_id required: true schema: - description: Filter Id + description: Appdef Id + type: string + - description: Override Id + in: path + name: override_id + required: true + schema: + description: Override Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/GlobalPrefixFilter' + $ref: '#/components/schemas/AppdefOverrideV2N1' description: Successful Operation - summary: Delete Global Prefix Filter (v2.0) + summary: Delete application definition overrides for system appdef (v2.1) tags: - Applications get: - description: Get a specific global prefix filter. - operationId: get-v2.0-api-tenants-tenant_id-globalprefixfilters-filter_id + description: Get application definition overrides for system appdef + operationId: get-v2.1-api-tenants-tenant_id-appdefs-appdef_id-overrides-override_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the global prefix filter. + - description: Application definition Id in: path - name: filter_id + name: appdef_id required: true schema: - description: Filter Id + description: Appdef Id + type: string + - description: Override Id + in: path + name: override_id + required: true + schema: + description: Override Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/GlobalPrefixFilter' + $ref: '#/components/schemas/AppdefOverrideV2N1' description: Successful Operation - summary: Get Specific Global Prefix Filter (v2.0) + summary: Get application definition overrides for system appdef (v2.1) tags: - Applications put: - description: Update a new global prefix filter. - operationId: put-v2.0-api-tenants-tenant_id-globalprefixfilters-filter_id + description: Update a application definition overrides for system appdef + operationId: put-v2.1-api-tenants-tenant_id-appdefs-appdef_id-overrides-override_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the new global prefix filter. + - description: Application definition Id in: path - name: filter_id + name: appdef_id required: true schema: - description: Filter Id + description: Appdef Id + type: string + - description: Appdef overrides Id + in: path + name: override_id + required: true + schema: + description: Override Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/GlobalPrefixFilterScreen' - description: Details to update the global prefix filter. + $ref: '#/components/schemas/AppdefOverrideScreenV2N1' + description: Application definition Override responses: '200': content: application/json: schema: - $ref: '#/components/schemas/GlobalPrefixFilterScreen' + $ref: '#/components/schemas/AppdefOverrideV2N1' description: Successful Operation '400': content: @@ -3356,23 +6183,41 @@ paths: example: value: _error: - - code: SECURITY_FILTER_DUPLICATE_FILTER - - code: SECURITY_FILTER_NAME_REQUIRED - - code: SECURITY_FILTER_INVALID_NAME - - code: SECURITY_FILTER_INVALID_DESCRIPTION - - code: JSON_SCHEMA_MISMATCH + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_APP_NOT_EXISTS + - code: APPDEF_CONFIG_INVALID_APPDEF_ID + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_DEPRECATED_APP + - code: APPDEF_CONFIG_INVALID_OVERRIDE_DOMAIN_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_TCP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_UDP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_IP_FLAG + - code: APPDEF_CONFIG_NOT_ALLOWED + - code: APPDEF_CONFIG_MISSING_UDP_PORTS + - code: APPDEF_CONFIG_MISSING_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_UDP_PORTS + - code: APPDEF_CONFIG_READ_ONLY_USE_PARENTAPP_NETWORK_POLICY + - code: APPDEF_CONFIG_READ_ONLY_APP_UNREACHABILITY_DETECTION schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Global Prefix Filter (v2.0) + summary: Update a application definition overrides for system appdef (v2.1) tags: - Applications - /v2.0/api/tenants/{tenant_id}/localprefixfilters: + /v2.2/api/tenants/{tenant_id}/appdefs: get: - description: Get the local prefix filters. - operationId: get-v2.0-api-tenants-tenant_id-localprefixfilters + description: Get all application definitions + operationId: get-v2.2-api-tenants-tenant_id-appdefs parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true @@ -3389,18 +6234,18 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LocalPrefixFilter' + $ref: '#/components/schemas/AppDefV2N2' type: array type: object description: Successful Operation - summary: Get Local Prefix Filters (v2.0) + summary: Get all application definitions (v2.2) tags: - Applications post: - description: Create a new local prefix filter. - operationId: post-v2.0-api-tenants-tenant_id-localprefixfilters + description: Create a application definition + operationId: post-v2.2-api-tenants-tenant_id-appdefs parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true @@ -3411,14 +6256,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LocalPrefixFilterScreen' - description: Details of the prefix filter to be created + $ref: '#/components/schemas/AppDefScreenV2N2' + description: Application definition responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LocalPrefixFilter' + $ref: '#/components/schemas/AppDefV2N2' description: Successful Operation '400': content: @@ -3426,24 +6271,34 @@ paths: example: value: _error: - - code: SECURITY_FILTER_DUPLICATE_FILTER - - code: SECURITY_FILTER_NAME_REQUIRED - - code: SECURITY_FILTER_INVALID_NAME - - code: SECURITY_FILTER_INVALID_DESCRIPTION - - code: JSON_SCHEMA_MISMATCH + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_UPDATING_READ_ONLY_FIELD + - code: APPDEF_CONFIG_INVALID_TYPE + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_ORDER_NUMBER + - code: APPDEF_CONFIG_INVALID_ORDER_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_APP_UNREACHABILITY_DETECTION + - code: APPDEF_CONFIG_INVALID_NWTWORK_SCAN_APPLICATION schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create New Local Prefix Filter (v2.0) + summary: Create a application definition (v2.2) tags: - Applications - /v2.0/api/tenants/{tenant_id}/localprefixfilters/query: + /v2.2/api/tenants/{tenant_id}/appdefs/query: post: - description: Lists the query details for the list of parameters for local prefix - filters. - operationId: post-v2.0-api-tenants-tenant_id-localprefixfilters-query + description: Queries db for limit number of app defs that match query params. + operationId: post-v2.2-api-tenants-tenant_id-appdefs-query parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true @@ -3454,8 +6309,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LocalPrefixQuery' - description: Query Details for Local Prefix Filter + $ref: '#/components/schemas/AppDefQuery' + description: Query Details for the app def responses: '200': content: @@ -3466,7 +6321,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LocalPrefixFilter' + $ref: '#/components/schemas/AppDefQueryFilterTransformed' type: array type: object description: Successful Operation @@ -3476,38 +6331,38 @@ paths: example: value: _error: - - code: BAD_QUERY_REQUEST + - code: GENERAL_CONFIG_ERROR schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Local Prefix Filters (v2.0) + summary: Queries db for limit number of app defs that match query params. (v2.2) tags: - Applications - /v2.0/api/tenants/{tenant_id}/localprefixfilters/{id}: + /v2.2/api/tenants/{tenant_id}/appdefs/{appdef_id}: delete: - description: Delete a specific local prefix filter. - operationId: delete-v2.0-api-tenants-tenant_id-localprefixfilters-id + description: Delete a application definition + operationId: delete-v2.2-api-tenants-tenant_id-appdefs-appdef_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the local prefix filter. + - description: Application definition Id in: path - name: id + name: appdef_id required: true schema: - description: Id + description: Appdef Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LocalPrefixFilter' + $ref: '#/components/schemas/AppDefV2N2' description: Successful Operation '400': content: @@ -3515,73 +6370,74 @@ paths: example: value: _error: - - code: PREFIXFILTER_NAME_REQUIRED - - code: PREFIXFILTER_INVALID_DESCRIPTION - - code: PREFIXFILTER_INVALID_NAME + - code: APPDEF_CONFIG_INVALID_APP + - code: APPDEF_CONFIG_APP_IN_USE + - code: APPLICATION_IS_USED_IN_IPFIX_PROFILE + - code: APPLICATION_IS_USED_IN_IPFIX_CONFIG schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Local Prefix Filter (v2.0) + summary: Delete a application definition (v2.2) tags: - Applications get: - description: Get a specific global prefix filter. - operationId: get-v2.0-api-tenants-tenant_id-localprefixfilters-id + description: Get application definition + operationId: get-v2.2-api-tenants-tenant_id-appdefs-appdef_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the local prefix filter. + - description: Application definition Id in: path - name: id + name: appdef_id required: true schema: - description: Id + description: Appdef Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LocalPrefixFilter' + $ref: '#/components/schemas/AppDefV2N2' description: Successful Operation - summary: Get Specific Local Prefix Filter (v2.0) + summary: Get application definition (v2.2) tags: - Applications put: - description: Update a new local prefix filter. - operationId: put-v2.0-api-tenants-tenant_id-localprefixfilters-id + description: Update a application definition + operationId: put-v2.2-api-tenants-tenant_id-appdefs-appdef_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the new local prefix filter. + - description: Application definition Id in: path - name: id + name: appdef_id required: true schema: - description: Id + description: Appdef Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/LocalPrefixFilterScreen' - description: Details to update the local prefix filter. + $ref: '#/components/schemas/AppDefScreenV2N2' + description: Application definition responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LocalPrefixFilterScreen' + $ref: '#/components/schemas/AppDefV2N2' description: Successful Operation '400': content: @@ -3589,15 +6445,28 @@ paths: example: value: _error: - - code: SECURITY_FILTER_DUPLICATE_FILTER - - code: SECURITY_FILTER_NAME_REQUIRED - - code: SECURITY_FILTER_INVALID_NAME - - code: SECURITY_FILTER_INVALID_DESCRIPTION - - code: JSON_SCHEMA_MISMATCH + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_UPDATING_READ_ONLY_FIELD + - code: APPDEF_CONFIG_INVALID_TYPE + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_ORDER_NUMBER + - code: APPDEF_CONFIG_INVALID_ORDER_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_UDP_PORTS + - code: APPDEF_CONFIG_DEPRECATED_APP + - code: APPDEF_CONFIG_INVALID_APP_UNREACHABILITY_DETECTION + - code: APPDEF_CONFIG_INVALID_NWTWORK_SCAN_APPLICATION schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Local Prefix Filter (v2.0) + summary: Update a application definition (v2.2) tags: - Applications /v2.2/api/tenants/{tenant_id}/appdefs/{appdef_id}/overrides: @@ -3803,7 +6672,269 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AppdefOverrideV2N2' + $ref: '#/components/schemas/AppdefOverrideV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_APP_NOT_EXISTS + - code: APPDEF_CONFIG_INVALID_APPDEF_ID + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_DEPRECATED_APP + - code: APPDEF_CONFIG_INVALID_OVERRIDE_DOMAIN_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_TCP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_UDP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_IP_FLAG + - code: APPDEF_CONFIG_NOT_ALLOWED + - code: APPDEF_CONFIG_MISSING_UDP_PORTS + - code: APPDEF_CONFIG_MISSING_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_UDP_PORTS + - code: APPDEF_CONFIG_READ_ONLY_USE_PARENTAPP_NETWORK_POLICY + - code: APPDEF_CONFIG_READ_ONLY_APP_UNREACHABILITY_DETECTION + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Application Definition Overrides for System Appdef (v2.2) + tags: + - Applications + /v2.3/api/tenants/{tenant_id}/appdefs: + get: + description: Get all application definitions + operationId: get-v2.3-api-tenants-tenant_id-appdefs + parameters: + - description: 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/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AppDefV2N3' + type: array + type: object + description: Successful Operation + summary: Get all application definitions (v2.3) + tags: + - Applications + post: + description: Create a application definition + operationId: post-v2.3-api-tenants-tenant_id-appdefs + 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/AppDefScreenV2N3' + description: Application definition + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_UPDATING_READ_ONLY_FIELD + - code: APPDEF_CONFIG_INVALID_TYPE + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_ORDER_NUMBER + - code: APPDEF_CONFIG_INVALID_ORDER_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_APP_UNREACHABILITY_DETECTION + - code: APPDEF_CONFIG_INVALID_NWTWORK_SCAN_APPLICATION + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create a application definition (v2.3) + tags: + - Applications + /v2.3/api/tenants/{tenant_id}/appdefs/query: + post: + description: Queries db for limit number of app defs that match query params. + operationId: post-v2.3-api-tenants-tenant_id-appdefs-query + 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/AppDefQuery' + description: Query Details for the app def + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AppDefQueryFilterTransformedV2N3' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: GENERAL_CONFIG_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Queries db for limit number of app defs that match query params. (v2.3) + tags: + - Applications + /v2.3/api/tenants/{tenant_id}/appdefs/{appdef_id}: + delete: + description: Delete a application definition + operationId: delete-v2.3-api-tenants-tenant_id-appdefs-appdef_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Application definition Id + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_INVALID_APP + - code: APPDEF_CONFIG_APP_IN_USE + - code: APPLICATION_IS_USED_IN_IPFIX_PROFILE + - code: APPLICATION_IS_USED_IN_IPFIX_CONFIG + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete a application definition (v2.3) + tags: + - Applications + get: + description: Get application definition + operationId: get-v2.3-api-tenants-tenant_id-appdefs-appdef_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Application definition Id + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefV2N3' + description: Successful Operation + summary: Get application definition (v2.3) + tags: + - Applications + put: + description: Update a application definition + operationId: put-v2.3-api-tenants-tenant_id-appdefs-appdef_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Application definition Id + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefScreenV2N3' + description: Application definition + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefV2N3' description: Successful Operation '400': content: @@ -3812,32 +6943,27 @@ paths: value: _error: - code: APPDEF_CONFIG_NO_SYSTEM_APPS - - code: APPDEF_CONFIG_APP_NOT_EXISTS - - code: APPDEF_CONFIG_INVALID_APPDEF_ID + - code: APPDEF_CONFIG_UPDATING_READ_ONLY_FIELD + - code: APPDEF_CONFIG_INVALID_TYPE - code: APPDEF_CONFIG_INVALID_PROTOCOL - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_ORDER_NUMBER + - code: APPDEF_CONFIG_INVALID_ORDER_CONFIG - code: APPDEF_CONFIG_INVALID_DSCP - code: APPDEF_CONFIG_INVALID_TIMEOUT - code: APPDEF_CONFIG_INVALID_INGRESS - code: APPDEF_CONFIG_INVALID_PATHAFFINITY - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE - code: APPDEF_CONFIG_INVALID_TCP_PORTS - - code: APPDEF_CONFIG_DEPRECATED_APP - - code: APPDEF_CONFIG_INVALID_OVERRIDE_DOMAIN_FLAG - - code: APPDEF_CONFIG_INVALID_OVERRIDE_TCP_FLAG - - code: APPDEF_CONFIG_INVALID_OVERRIDE_UDP_FLAG - - code: APPDEF_CONFIG_INVALID_OVERRIDE_IP_FLAG - - code: APPDEF_CONFIG_NOT_ALLOWED - - code: APPDEF_CONFIG_MISSING_UDP_PORTS - - code: APPDEF_CONFIG_MISSING_TCP_PORTS - code: APPDEF_CONFIG_INVALID_UDP_PORTS - - code: APPDEF_CONFIG_READ_ONLY_USE_PARENTAPP_NETWORK_POLICY - - code: APPDEF_CONFIG_READ_ONLY_APP_UNREACHABILITY_DETECTION + - code: APPDEF_CONFIG_DEPRECATED_APP + - code: APPDEF_CONFIG_INVALID_APP_UNREACHABILITY_DETECTION + - code: APPDEF_CONFIG_INVALID_NWTWORK_SCAN_APPLICATION schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Application Definition Overrides for System Appdef (v2.2) + summary: Update a application definition (v2.3) tags: - Applications /v2.3/api/tenants/{tenant_id}/appdefs/{appdef_id}/overrides: @@ -4338,264 +7464,6 @@ paths: summary: Update Application Definition (v2.4) tags: - Applications - /v2.5/api/tenants/{tenant_id}/appdefs: - get: - description: Lists all the application definitions. - operationId: get-v2.5-api-tenants-tenant_id-appdefs - 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/BulkResponse' - - properties: - items: - items: - $ref: '#/components/schemas/AppDefV2N5' - type: array - type: object - description: Successful Operation - summary: Get all Application Definitions (v2.5) - tags: - - Applications - post: - description: Create an application definition. - operationId: post-v2.5-api-tenants-tenant_id-appdefs - 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/AppDefScreenV2N5' - description: Application definition - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AppDefV2N5' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: APPDEF_CONFIG_NO_SYSTEM_APPS - - code: APPDEF_CONFIG_UPDATING_READ_ONLY_FIELD - - code: APPDEF_CONFIG_INVALID_TYPE - - code: APPDEF_CONFIG_INVALID_PROTOCOL - - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT - - code: APPDEF_CONFIG_INVALID_RULE_CONFIG - - code: APPDEF_CONFIG_INVALID_ORDER_NUMBER - - code: APPDEF_CONFIG_INVALID_ORDER_CONFIG - - code: APPDEF_CONFIG_INVALID_DSCP - - code: APPDEF_CONFIG_INVALID_TIMEOUT - - code: APPDEF_CONFIG_INVALID_INGRESS - - code: APPDEF_CONFIG_INVALID_PATHAFFINITY - - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE - - code: APPDEF_CONFIG_INVALID_TCP_PORTS - - code: APPDEF_CONFIG_INVALID_APP_UNREACHABILITY_DETECTION - - code: APPDEF_CONFIG_INVALID_NWTWORK_SCAN_APPLICATION - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Application Definition (v2.5) - tags: - - Applications - /v2.5/api/tenants/{tenant_id}/appdefs/query: - post: - description: Queries the DB for limit number of appdefs that match the query - parameters. - operationId: post-v2.5-api-tenants-tenant_id-appdefs-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/AppDefQuery' - description: Query Details for the app def - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/AppDefQueryFilterTransformedV2N4' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: GENERAL_CONFIG_ERROR - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query DB for Number of AppDefs that Match Query Params (v2.5) - tags: - - Applications - /v2.5/api/tenants/{tenant_id}/appdefs/{appdef_id}: - delete: - description: Delete an application definition. - operationId: delete-v2.5-api-tenants-tenant_id-appdefs-appdef_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The ID of the application definition. - in: path - name: appdef_id - required: true - schema: - description: Appdef Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AppDefV2N5' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: APPDEF_CONFIG_INVALID_APP - - code: APPDEF_CONFIG_APP_IN_USE - - code: APPLICATION_IS_USED_IN_IPFIX_PROFILE - - code: APPLICATION_IS_USED_IN_IPFIX_CONFIG - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Application Definition (v2.5) - tags: - - Applications - get: - description: Get the application definition. - operationId: get-v2.5-api-tenants-tenant_id-appdefs-appdef_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: Get the ID of the application definition. - in: path - name: appdef_id - required: true - schema: - description: Appdef Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AppDefV2N5' - description: Successful Operation - summary: Get Application Definition (v2.5) - tags: - - Applications - put: - description: Update an application definition. - operationId: put-v2.5-api-tenants-tenant_id-appdefs-appdef_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The ID of the application definition. - in: path - name: appdef_id - required: true - schema: - description: Appdef Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AppDefScreenV2N5' - description: Application definition - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AppDefV2N5' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: APPDEF_CONFIG_NO_SYSTEM_APPS - - code: APPDEF_CONFIG_UPDATING_READ_ONLY_FIELD - - code: APPDEF_CONFIG_INVALID_TYPE - - code: APPDEF_CONFIG_INVALID_PROTOCOL - - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT - - code: APPDEF_CONFIG_INVALID_RULE_CONFIG - - code: APPDEF_CONFIG_INVALID_ORDER_NUMBER - - code: APPDEF_CONFIG_INVALID_ORDER_CONFIG - - code: APPDEF_CONFIG_INVALID_DSCP - - code: APPDEF_CONFIG_INVALID_TIMEOUT - - code: APPDEF_CONFIG_INVALID_INGRESS - - code: APPDEF_CONFIG_INVALID_PATHAFFINITY - - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE - - code: APPDEF_CONFIG_INVALID_TCP_PORTS - - code: APPDEF_CONFIG_INVALID_UDP_PORTS - - code: APPDEF_CONFIG_DEPRECATED_APP - - code: APPDEF_CONFIG_INVALID_APP_UNREACHABILITY_DETECTION - - code: APPDEF_CONFIG_INVALID_NWTWORK_SCAN_APPLICATION - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Application Definition (v2.5) - tags: - - Applications servers: - url: https://api.us.cloudgenix.com tags: diff --git a/openapi-specs/sdwan/legacy/Auditlogs.yaml b/openapi-specs/sdwan/legacy/Auditlogs.yaml index 9f68bcb52..dcf13cd19 100644 --- a/openapi-specs/sdwan/legacy/Auditlogs.yaml +++ b/openapi-specs/sdwan/legacy/Auditlogs.yaml @@ -2,21 +2,9 @@ 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: @@ -26,28 +14,6 @@ components: - 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 AuditLog: properties: esp_tenant_id: diff --git a/openapi-specs/sdwan/legacy/BulkOperations.yaml b/openapi-specs/sdwan/legacy/BulkOperations.yaml index c3029929e..53782b862 100644 --- a/openapi-specs/sdwan/legacy/BulkOperations.yaml +++ b/openapi-specs/sdwan/legacy/BulkOperations.yaml @@ -2,21 +2,9 @@ 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: @@ -26,28 +14,6 @@ components: - 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 BaseQuery: properties: aggregate: diff --git a/openapi-specs/sdwan/legacy/Cellular.yaml b/openapi-specs/sdwan/legacy/Cellular.yaml index 26df2a09d..342e61d9c 100644 --- a/openapi-specs/sdwan/legacy/Cellular.yaml +++ b/openapi-specs/sdwan/legacy/Cellular.yaml @@ -251,21 +251,9 @@ components: - name 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: @@ -275,28 +263,6 @@ components: - 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 BulkResponse: properties: count: diff --git a/openapi-specs/sdwan/legacy/CloudBlades.yaml b/openapi-specs/sdwan/legacy/CloudBlades.yaml index a06ef5d82..2d2e5aba9 100644 --- a/openapi-specs/sdwan/legacy/CloudBlades.yaml +++ b/openapi-specs/sdwan/legacy/CloudBlades.yaml @@ -68,6 +68,76 @@ components: ' type: string type: object + Parameter: + properties: + default_value: + description: 'The default value. + + ' + type: object + display_label: + description: 'The display label of the SD-WAN app. + + ' + type: string + help_text: + description: 'The help text in the app. + + ' + type: string + key: + description: 'The SD-WAN app config key. + + ' + type: string + max_length: + description: 'The max length of the SD-WAN app parameters. + + ' + type: integer + max_value: + description: 'The max value of the SD-WAN app parameters. + + ' + type: object + min_value: + description: 'The min value of the SD-WAN app parameters. + + ' + type: object + regex: + description: 'The regex values. + + ' + type: string + required: + description: 'The SD-WAN app required parameters. + + ' + type: boolean + sensitive: + description: 'The SD-WAN app sensitive parameters. + + ' + type: boolean + type: + description: 'The SD-WAN app parameters type. + + ' + enum: + - INTEGER + - FLOAT + - STRING + - TEXT + - EMAIL + - LIST_INTEGER + - LIST_FLOAT + - LIST_STRING + - LIST_INTEGER_MULTI_SELECT + - LIST_FLOAT_MULTI_SELECT + - LIST_STRING_MULTI_SELECT + - BOOLEAN + type: string ParameterListValueResponse: properties: display_label: @@ -429,6 +499,114 @@ components: - version - name - tenant_id + SDWANAppReleaseInfo: + properties: + default_release: + description: 'The default release of the app. + + ' + type: boolean + description: + description: 'The description of the SD-WAN app. Max length = 256. + + ' + name: + description: 'The name of the SD-WAN app. + + ' + type: string + parameters: + description: 'The app parameters. + + ' + items: + $ref: '#/components/schemas/Parameter' + type: array + permissions: + description: 'The permissions of the SD-WAN app. + + ' + items: + description: Permissions + type: string + type: array + release_date: + description: 'The release date of the SD-WAN app. + + ' + format: int64 + type: integer + release_notes: + description: 'The release notes of the SD-WAN app. + + ' + type: string + state: + description: 'The release state of the SD-WAN app. + + ' + enum: + - INIT + - ALPHA + - BETA + - GA + - DEPRECATED + - TO_BE_DELETED + type: string + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 unique tags of length 128 each are allowed. + + ' + items: + description: Tags + type: string + type: array + version: + description: 'The version of the SD-WAN app. + + ' + type: string + SDWANAppReleaseInfoResponse: + properties: + author: + $ref: '#/components/schemas/Author' + description: 'Details of the SD-WAN app owner. + + ' + description: + description: 'The description of the SD-WAN app. Max length = 256. + + ' + id: + description: 'The SD-WAN app ID. + + ' + type: string + name: + description: 'The name of the SD-WAN app. + + ' + type: string + releases: + description: 'The release information of the SD-WAN apps. + + ' + items: + $ref: '#/components/schemas/SDWANAppReleaseInfo' + type: array + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 unique tags of length 128 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - author + - name SDWANAppReleaseInfoResponseV2N1: properties: author: @@ -691,6 +869,64 @@ info: version: Latest openapi: 3.0.0 paths: + /v2.0/api/tenants/{tenant_id}/sdwanapps: + get: + description: GET existing tenant SD-WAN applications with release information. + operationId: get-v2.0-api-tenants-tenant_id-sdwanapps + parameters: + - description: 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/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SDWANAppReleaseInfoResponse' + type: array + type: object + description: Successful Operation + summary: GET existing tenant SD-WAN applications with release information. (v2.0) + tags: + - CloudBlades + /v2.0/api/tenants/{tenant_id}/sdwanapps/{app_id}: + get: + description: GET existing tenant SD-WAN application with release information. + operationId: get-v2.0-api-tenants-tenant_id-sdwanapps-app_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: SDWAN-APP tenant App ID + in: path + name: app_id + required: true + schema: + description: App Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SDWANAppReleaseInfoResponse' + description: Successful Operation + summary: GET existing tenant SD-WAN application with release information. (v2.0) + tags: + - CloudBlades /v2.0/api/tenants/{tenant_id}/sdwanapps/{app_id}/configs: get: description: List all the SD-WAN application configurations. diff --git a/openapi-specs/sdwan/legacy/DHCP.yaml b/openapi-specs/sdwan/legacy/DHCP.yaml index 7c3daa698..e0c3ecafd 100644 --- a/openapi-specs/sdwan/legacy/DHCP.yaml +++ b/openapi-specs/sdwan/legacy/DHCP.yaml @@ -1,5 +1,20 @@ components: schemas: + BaseCustomDHCPOptions: + properties: + option_definition: + description: 'Custom option definition. Max length supported is 1024. + + ' + type: string + option_value: + description: 'Custom option value. Max length supported is 8192. + + ' + type: string + required: + - option_value + - option_definition CustomDHCPOptions: properties: option_definition: @@ -18,16 +33,8 @@ components: required: - option_value - option_definition - DHCPServerScreenV2N2: + DHCPServer: properties: - address_family: - description: 'The DHCP config address values. - - ' - enum: - - IPV4 - - IPV6 - type: string broadcast_address: description: 'The address of the site. @@ -38,7 +45,7 @@ components: ' items: - $ref: '#/components/schemas/CustomDHCPOptions' + $ref: '#/components/schemas/BaseCustomDHCPOptions' type: array default_lease_time: description: 'The lease time each client will get if a user does not request @@ -102,7 +109,7 @@ components: ' items: - $ref: '#/components/schemas/StaticMappingV2' + $ref: '#/components/schemas/StaticMapping' type: array subnet: description: 'The subnet for which the DHCP server is being configured. @@ -119,19 +126,10 @@ components: type: string type: array required: - - address_family - ip_ranges - subnet - DHCPServerScreenV2N3: + DHCPServerScreen: properties: - address_family: - description: 'The DHCP config address values. - - ' - enum: - - IPV4 - - IPV6 - type: string broadcast_address: description: 'The address of the site. @@ -142,7 +140,7 @@ components: ' items: - $ref: '#/components/schemas/CustomDHCPOptions' + $ref: '#/components/schemas/BaseCustomDHCPOptions' type: array default_lease_time: description: 'The lease time each client will get if a user does not request @@ -206,7 +204,7 @@ components: ' items: - $ref: '#/components/schemas/StaticMappingV2' + $ref: '#/components/schemas/StaticMapping' type: array subnet: description: 'The subnet for which the DHCP server is being configured. @@ -222,25 +220,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 - subnet - DHCPServerV2N2: + DHCPServerScreenV2N1: properties: - address_family: - description: 'The DHCP config address values. - - ' - enum: - - IPV4 - - IPV6 - type: string broadcast_address: description: 'The address of the site. @@ -315,7 +299,7 @@ components: ' items: - $ref: '#/components/schemas/StaticMappingV2' + $ref: '#/components/schemas/StaticMapping' type: array subnet: description: 'The subnet for which the DHCP server is being configured. @@ -332,19 +316,10 @@ components: type: string type: array required: - - address_family - ip_ranges - subnet - DHCPServerV2N3: + DHCPServerV2N1: properties: - address_family: - description: 'The DHCP config address values. - - ' - enum: - - IPV4 - - IPV6 - type: string broadcast_address: description: 'The address of the site. @@ -419,7 +394,7 @@ components: ' items: - $ref: '#/components/schemas/StaticMappingV2' + $ref: '#/components/schemas/StaticMapping' type: array subnet: description: 'The subnet for which the DHCP server is being configured. @@ -435,13 +410,7 @@ 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 Error: @@ -494,11 +463,8 @@ components: ' type: string type: object - StaticMappingV2: + StaticMapping: 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. @@ -514,6 +480,7 @@ components: type: string required: - ip_address + - mac - name info: contact: {} @@ -522,20 +489,19 @@ info: version: Latest openapi: 3.0.0 paths: - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/dhcpservers: + /v2.0/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 + description: Get all DHCPServers for a Tenant on a site + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-dhcpservers parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -552,26 +518,25 @@ paths: - properties: items: items: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServer' type: array type: object description: Successful Operation - summary: Get DHCP Servers for Tenant on Site (v2.2) + summary: Get all DHCPServers for a Tenant on a site (v2.0) 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 + description: Create a new dhcp server configuration for a subnet + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-dhcpservers parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -582,14 +547,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerScreenV2N2' + $ref: '#/components/schemas/DHCPServerScreen' description: Details of dhcp server config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServer' description: Successful Operation '400': content: @@ -609,41 +574,32 @@ 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.2) + summary: Create a new dhcp server configuration for a subnet (v2.0) tags: - DHCP - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/dhcpservers/{dhcp_server_id}: + /v2.0/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 + description: Delete DHCPServer for a Tenant on a site + operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 schema: description: Site Id type: string - - description: ID of the DHCP server. + - description: DHCP Server Id in: path name: dhcp_server_id required: true @@ -655,31 +611,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServer' description: Successful Operation - summary: Delete DHCP Server for Tenant on Site (v2.2) + summary: Delete DHCPServer for a Tenant on a site (v2.0) 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 + description: Get DHCPServer for a Tenant on a site + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 schema: description: Site Id type: string - - description: ID of the DHCP server. + - description: DHCP Server Id in: path name: dhcp_server_id required: true @@ -691,31 +646,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServer' description: Successful Operation - summary: Get DHCP Server for Tenant on Site (v2.2) + summary: Get DHCPServer for a Tenant on a site (v2.0) 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 + description: Update an existing dhcp server configuration for a subnet + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 schema: description: Site Id type: string - - description: ID of the DHCP server configuration. + - description: DHCP Server Config Id in: path name: dhcp_server_id required: true @@ -726,14 +680,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerScreenV2N2' + $ref: '#/components/schemas/DHCPServerScreen' description: Details of dhcp server config to be Updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServer' description: Successful Operation '400': content: @@ -753,34 +707,25 @@ 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.2) + summary: Update an existing dhcp server configuration for a subnet (v2.0) tags: - DHCP - /v2.3/api/tenants/{tenant_id}/sites/{site_id}/dhcpservers: + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/dhcpservers: get: - description: Get all the DHCP servers for a tenant on a site. - operationId: get-v2.3-api-tenants-tenant_id-sites-site_id-dhcpservers + description: Get all DHCPServers for a Tenant on a site + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-dhcpservers parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -797,26 +742,25 @@ paths: - properties: items: items: - $ref: '#/components/schemas/DHCPServerV2N3' + $ref: '#/components/schemas/DHCPServerV2N1' type: array type: object description: Successful Operation - summary: Get DHCP Servers for Tenant on Site (v2.3) + summary: Get all DHCPServers for a Tenant on a site (v2.1) tags: - DHCP post: - description: Create a new DHCP server configuration for a subnet. - operationId: post-v2.3-api-tenants-tenant_id-sites-site_id-dhcpservers + description: Create a new dhcp server configuration for a subnet + operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-dhcpservers parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -827,14 +771,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerScreenV2N3' + $ref: '#/components/schemas/DHCPServerScreenV2N1' description: Details of dhcp server config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N3' + $ref: '#/components/schemas/DHCPServerV2N1' description: Successful Operation '400': content: @@ -854,41 +798,32 @@ 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.3) + summary: Create a new dhcp server configuration for a subnet (v2.1) tags: - DHCP - /v2.3/api/tenants/{tenant_id}/sites/{site_id}/dhcpservers/{dhcp_server_id}: + /v2.1/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.3-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id + description: Delete DHCPServer for a Tenant on a site + operationId: delete-v2.1-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 schema: description: Site Id type: string - - description: ID of the DHCP server. + - description: resource Id in: path name: dhcp_server_id required: true @@ -900,31 +835,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N3' + $ref: '#/components/schemas/DHCPServerV2N1' description: Successful Operation - summary: Delete DHCP Server for Tenant on Site (v2.3) + summary: Delete DHCPServer for a Tenant on a site (v2.1) tags: - DHCP get: - description: List the DHCP server for a tenant on a site. - operationId: get-v2.3-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id + description: Get DHCPServer for a Tenant on a site + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 schema: description: Site Id type: string - - description: ID of the DHCP server. + - description: resource Id in: path name: dhcp_server_id required: true @@ -936,31 +870,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N3' + $ref: '#/components/schemas/DHCPServerV2N1' description: Successful Operation - summary: Get DHCP Server for Tenant on Site (v2.3) + summary: Get DHCPServer for a Tenant on a site (v2.1) tags: - DHCP put: - description: Update an existing DHCP server configuration for a subnet. - operationId: put-v2.3-api-tenants-tenant_id-sites-site_id-dhcpservers-dhcp_server_id + 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 parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 schema: description: Site Id type: string - - description: ID of the DHCP server configuration. + - description: config Id in: path name: dhcp_server_id required: true @@ -971,14 +904,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerScreenV2N3' + $ref: '#/components/schemas/DHCPServerScreenV2N1' description: Details of dhcp server config to be Updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N3' + $ref: '#/components/schemas/DHCPServerV2N1' description: Successful Operation '400': content: @@ -998,18 +931,10 @@ 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.2) + summary: Update an existing dhcp server configuration for a subnet (v2.1) tags: - DHCP servers: diff --git a/openapi-specs/sdwan/legacy/DNSServices.yaml b/openapi-specs/sdwan/legacy/DNSServices.yaml index 5f5962b80..43c367746 100644 --- a/openapi-specs/sdwan/legacy/DNSServices.yaml +++ b/openapi-specs/sdwan/legacy/DNSServices.yaml @@ -2,21 +2,9 @@ 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: @@ -26,28 +14,6 @@ components: - 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 Alias: properties: mask: @@ -320,33 +286,6 @@ components: type: boolean required: - dns_servers - DnsForwardConfigV2: - properties: - dns_servers: - description: 'Details of the DNS severs. - - ' - items: - $ref: '#/components/schemas/DnsServersV2' - type: array - max_source_port: - description: 'The DNS service max source port. - - ' - type: integer - min_source_port: - description: 'The DNS service min source port. - - ' - format: int32 - type: integer - send_to_all_dns_servers: - description: 'If the option es enabled to send to all DNS servers. - - ' - type: boolean - required: - - dns_servers DnsQueriesMetadata: properties: add_client_mac: @@ -505,50 +444,6 @@ components: type: integer required: - dnsserver_ip - DnsServersV2: - properties: - address_family: - description: 'The DNS server address values. - - ' - enum: - - ipv4 - - ipv6 - - ipv4v6 - type: string - dnsserver_ip: - description: 'The DNS server IP address. - - ' - type: string - dnsserver_port: - description: 'The DNS server port. - - ' - type: integer - domain_names: - description: 'The DNS server domain names. - - ' - items: - description: Domain Names - type: string - type: array - forward_dnsservicerole_id: - description: 'The DNS forward service role ID. Max size = 20. - - ' - type: string - ip_prefix: - description: "The DNS server IP prefix. \n" - type: string - source_port: - description: 'The DNS server source port. - - ' - type: integer - required: - - dnsserver_ip DnsService: properties: cache_config: @@ -857,104 +752,6 @@ components: ' format: int64 type: integer - DnsServiceProfileV2N1: - properties: - authoritative_config: - $ref: '#/components/schemas/AuthoritativeConfig' - description: "The configuration details of the authoritative DNS server\ - \ where all the queries will try to resolve without forwarding it to external\ - \ servers. \n" - cache_config: - $ref: '#/components/schemas/CacheConfig' - description: 'Lists details of the cache configuration. - - ' - description: - description: 'The description of the DNS profiles. - - ' - dns_forward_config: - $ref: '#/components/schemas/DnsForwardConfigV2' - description: "Lists details of the DNS forward requests configuration. \ - \ \n" - dns_queries_metadata: - $ref: '#/components/schemas/DnsQueriesMetadata' - description: 'Lists the DNS queries parameters that append the client metadata - to the DNS query as it is sent to the upstream DNS server. - - ' - dns_rebind_config: - $ref: '#/components/schemas/DnsRebindConfig' - description: 'The details of the DNS rebind configuration. - - ' - dns_response_overrides: - $ref: '#/components/schemas/DnsResponseOverrides' - description: 'The details of the DNS response overrides. - - ' - dnssec_config: - $ref: '#/components/schemas/DnsSecConfig' - description: "The DNS secondary server configuration details. \ - \ \n" - domains_to_addresses: - description: 'The unique domain to address mapping and the IP address. - - ' - items: - $ref: '#/components/schemas/DomainsToAddress' - type: array - edns_packet_max: - description: 'The EDNS packets size. The default size is 4096. - - ' - format: int32 - type: integer - enable_dns_loop_detection: - description: 'If DNS loop detection is enabled. - - ' - type: boolean - enable_dnssec_proxy: - description: "If DNS second proxy is enabled. \n" - type: boolean - enable_strict_domain_name: - description: 'If DNS strict domain name is enabled. - - ' - type: boolean - id: - description: 'The ID. - - ' - type: string - listen_dnsservicerole_id: - description: "The ID mapped to the interfaces which are used for listening.\ - \ \n" - type: string - listen_port: - description: 'The port where the DNS is listening to the DNS queries. - - ' - format: int32 - type: integer - name: - description: 'The DNS profile name. - - ' - type: string - tags: - description: 'An information field that can be added to identify the DNS - profile. - - ' - items: - description: Tags - type: string - type: array - required: - - dns_forward_config - - name DnsServiceQuery: properties: aggregate: @@ -2535,396 +2332,6 @@ paths: summary: Update DNS Service Config (v2.0) tags: - DNS Services - /v2.1/api/tenants/{tenant_id}/dnsserviceprofiles: - get: - description: List all the DNS service profiles. - operationId: get-v2.1-api-tenants-tenant_id-dnsserviceprofiles - 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/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/DnsServiceProfileV2N1' - type: array - type: object - description: Successful Operation - summary: Get DNS Service Profiles (v2.1) - tags: - - DNS Services - post: - description: Create a new DNS service profile. - operationId: post-v2.1-api-tenants-tenant_id-dnsserviceprofiles - 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/DnsServiceProfileV2N1' - description: Details of the DNS service profile to be created - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DnsServiceProfileV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: DNSSERVICE_PROFILE_CREATE_FAILED - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: INVALID_PROFILE_CONFIG - - code: INVALID_LISTENROLE_ID - - code: DNSSERVER_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: DNSSERVER_INVALID_FWDROLE_ID - - code: DNSREBIND_DOMAIN_CONFIG_INVALID_HOST - - code: DUPLICATE_DOMAINTOADDRESS_MAPPING_UNSUPPORTED - - code: DOMAINTOADDRESS_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: TRUST_ANCHORS_MISSING - - code: DISABLE_DNSSEC_TIMECHECK_NOT_ALLOWED - - code: DNS_CHECK_UNSIGNED_NOT_ALLOWED - - code: DNSSEC_CONFIG_NOT_ALLOWED - - code: HOSTRECORD_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: INVALID_NAPTRRECORD_CONFIG - - code: INVALID_SYNTH_DOMAIN_CONFIG - - code: INVALID_ALIAS_CONFIG - - code: INVALID_ADD_CUSTOMER_PREMISES_EQUIPMENT_CONFIG - - code: NAME_EXCEEDS_LIMIT - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_TAG - - code: INVALID_DNSSERVER_LISTEN_PORT_RANGE_CONFIG - - code: DNSSERVICE_CONFIG_INVALID_MINSOURCEPORT_VALUE - - code: DNSSERVICE_CONFIG_INVALID_MAXSOURCEPORT_VALUE - - code: INVALID_DNSSERVER_IP_PREFIX_CONFIG - - code: INVALID_DNSSERVER_DOMAIN_NAMES_LIST_CONFIG - - code: DNSSERVER_IP_CONFIG_MISSING - - code: INVALID_DNSSERVER_IP_CONFIG_IP - - code: INVALID_DNSSERVER_PORT_RANGE_CONFIG - - code: INVALID_DNSSERVER_SOURCE_PORT_RANGE_CONFIG - - code: INVALID_CUSTOMER_PREMISES_EQUIPMENT_TYPE - - code: DNSQUERYMETADATA_CONFIG_INVALID_IP_ADDRESS - - code: DNSQUERYMETADATA_CONFIG_INVALID_IP_PREFIX_LENGTH_RANGE - - code: DNSQUERYMETADATA_CONFIG_INVALID_IPV6_ADDRESS - - code: DNSQUERYMETADATA_CONFIG_INVALID_IPV6_PREFIX_LENGTH_RANGE - - code: INVALID_BOGUS_NX_DOMAINS - - code: INVALID_IGNORE_IP_ADDRESS - - code: ALIAS_CONFIG_INVALID_ORIGINAL_IP - - code: ALIAS_CONFIG_INVALID_ORIGINAL_START_IP - - code: ALIAS_CONFIG_INVALID_ORIGINAL_END_IP - - code: ALIAS_CONFIG_REPLACE_IP_ADDRESS_MISSING - - code: INVALID_DNSREBIND_REBIND_DOMAINS_LIST_CONFIG - - code: INVALID_TRUSTANCHOR_KEY_TAG_RANGE_CONFIG - - code: INVALID_TRUSTANCHOR_KEY_DIGEST_ALGO_RANGE_CONFIG - - code: INVALID_TRUSTANCHOR_KEY_DIGEST_TYPE_RANGE_CONFIG - - code: INVALID_DOMAINTOADDRESS_DOMAIN_NAMES_LIST_CONFIG - - code: DOMAINTOADDRESS_IP_CONFIG_MISSING - - code: INVALID_SECONDARY_SERVER - - code: INVALID_PEER_ADDRESS - - code: AUTHCONFIG_SERVER_DOMAIN_NAME_CONFIG_MISSING - - code: AUTHCONFIG_SERVER_DOMAIN_NAME_CONFIG_INVALID_HOST - - code: AUTHCONFIG_ZONE_DOMAIN_NAME_CONFIG_MISSING - - code: AUTHCONFIG_ZONE_DOMAIN_NAME_CONFIG_INVALID_HOST - - code: AUTHCONFIG_ZONE_INVALID_INCLUDE_PREFIX - - code: AUTHCONFIG_ZONE_INVALID_EXCLUDE_PREFIX - - code: AUTHCONFIG_SOA_SERIAL_NUMBER_CONFIG_MISSING - - code: INVALID_HOSTRECORD_DOMAIN_NAMES_LIST_CONFIG - - code: INVALID_HOSTRECORD_IPV4_CONFIG - - code: INVALID_HOSTRECORD_IPV6_CONFIG - - code: SYNTHDOMAIN_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: INVALID_SYNTHDOMAIN_START_IP_ADDRESS_CONFIG - - code: INVALID_SYNTHDOMAIN_END_IP_ADDRESS_CONFIG - - code: INVALID_SYNTHDOMAIN_IP_ADDRESS_PREFIX_CONFIG - - code: SRVHOST_SERVICE_MISSING - - code: SRVHOST_PROTOCOL_MISSING - - code: SRVHOST_DOMAIN_NAME_CONFIG_INVALID_HOST - - code: INVALID_SRVHOST_PORT_RANGE_CONFIG - - code: INVALID_SRVHOST_PRIORITY_RANGE_CONFIG - - code: NAPTRRECORD_NAME_MISSING - - code: INVALID_NAPTRRECORD_ORDER_RANGE_CONFIG - - code: NAPTRRECORD_ORDER_MISSING - - code: INVALID_NAPTRRECORD_PREFERENCE_RANGE_CONFIG - - code: NAPTRRECORD_PREFERENCE_MISSING - - code: NAPTRRECORD_FLAGS_MISSING - - code: CAARECORD_NAME_MISSING - - code: CAARECORD_FLAG_MISSING - - code: CAARECORD_TAG_MISSING - - code: CAARECORD_VALUE_MISSING - - code: DNSRESOURCERECORD_NAME_MISSING - - code: DNSRESOURCERECORD_RRNUMBER_MISSING - - code: CNAMERECORD_NAME_MISSING - - code: CNAMERECORD_TARGET_MISSING - - code: PTRRECORD_NAME_MISSING - - code: TXTRECORD_DOMAIN_NAME_MISSING - - code: TXTRECORD_TEXT_INVALID_LENGTH - - code: MX_NAME_MISSING - - code: MX_HOST_NAME_MISSING - - code: MX_NAME_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: INVALID_DNSSERVER_IP_CONFIG_IPV6 - - code: INVALID_DNSSERVER_IPV6_PREFIX_CONFIG - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create DNS Service Profile (v2.1) - tags: - - DNS Services - /v2.1/api/tenants/{tenant_id}/dnsserviceprofiles/query: - post: - description: Query DNS service profiles based on parameters. - operationId: post-v2.1-api-tenants-tenant_id-dnsserviceprofiles-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/DnsServiceProfileQuery' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/DnsServiceProfileQuery' - type: array - type: object - description: Successful Operation - summary: Query DNS Service Profile (v2.1) - tags: - - DNS Services - /v2.1/api/tenants/{tenant_id}/dnsserviceprofiles/{dnsservice_role_id}: - delete: - description: Delete an existing DNS service profile. - operationId: delete-v2.1-api-tenants-tenant_id-dnsserviceprofiles-dnsservice_role_id - parameters: - - description: ID of the tenant. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: ID of the DNS service profile. - in: path - name: dnsservice_role_id - required: true - schema: - description: Dnsservice Role Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DnsServiceProfileV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: DNSPROFILE_CONFIG_DELETE_NOTALLOWED - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete DNS Service Profile (v2.1) - tags: - - DNS Services - get: - description: List a DNS service profile. - operationId: get-v2.1-api-tenants-tenant_id-dnsserviceprofiles-dnsservice_role_id - parameters: - - description: ID of the tenant. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: ID of the DNS service profile. - in: path - name: dnsservice_role_id - required: true - schema: - description: Dnsservice Role Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DnsServiceProfileV2N1' - description: Successful Operation - summary: Get DNS Service Profile (v2.1) - tags: - - DNS Services - put: - description: Update a DNS service profile. - operationId: put-v2.1-api-tenants-tenant_id-dnsserviceprofiles-dnsservice_role_id - parameters: - - description: ID of the tenant. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: ID of the DNS service profile. - in: path - name: dnsservice_role_id - required: true - schema: - description: Dnsservice Role Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DnsServiceProfileV2N1' - description: Details of the DNS service profile to be updated - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DnsServiceProfileV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: INVALID_PROFILE_CONFIG - - code: INVALID_LISTENROLE_ID - - code: DNSSERVER_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: DNSSERVER_INVALID_FWDROLE_ID - - code: DNSREBIND_DOMAIN_CONFIG_INVALID_HOST - - code: DUPLICATE_DOMAINTOADDRESS_MAPPING_UNSUPPORTED - - code: DOMAINTOADDRESS_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: TRUST_ANCHORS_MISSING - - code: DISABLE_DNSSEC_TIMECHECK_NOT_ALLOWED - - code: DNS_CHECK_UNSIGNED_NOT_ALLOWED - - code: DNSSEC_CONFIG_NOT_ALLOWED - - code: HOSTRECORD_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: INVALID_NAPTRRECORD_CONFIG - - code: INVALID_SYNTH_DOMAIN_CONFIG - - code: INVALID_ALIAS_CONFIG - - code: INVALID_ADD_CUSTOMER_PREMISES_EQUIPMENT_CONFIG - - code: NAME_EXCEEDS_LIMIT - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_TAG - - code: INVALID_DNSSERVER_LISTEN_PORT_RANGE_CONFIG - - code: DNSSERVICE_CONFIG_INVALID_MINSOURCEPORT_VALUE - - code: DNSSERVICE_CONFIG_INVALID_MAXSOURCEPORT_VALUE - - code: INVALID_DNSSERVER_IP_PREFIX_CONFIG - - code: INVALID_DNSSERVER_DOMAIN_NAMES_LIST_CONFIG - - code: DNSSERVER_IP_CONFIG_MISSING - - code: INVALID_DNSSERVER_IP_CONFIG_IP - - code: INVALID_DNSSERVER_PORT_RANGE_CONFIG - - code: INVALID_DNSSERVER_SOURCE_PORT_RANGE_CONFIG - - code: INVALID_CUSTOMER_PREMISES_EQUIPMENT_TYPE - - code: DNSQUERYMETADATA_CONFIG_INVALID_IP_ADDRESS - - code: DNSQUERYMETADATA_CONFIG_INVALID_IP_PREFIX_LENGTH_RANGE - - code: DNSQUERYMETADATA_CONFIG_INVALID_IPV6_ADDRESS - - code: DNSQUERYMETADATA_CONFIG_INVALID_IPV6_PREFIX_LENGTH_RANGE - - code: INVALID_BOGUS_NX_DOMAINS - - code: INVALID_IGNORE_IP_ADDRESS - - code: ALIAS_CONFIG_INVALID_ORIGINAL_IP - - code: ALIAS_CONFIG_INVALID_ORIGINAL_START_IP - - code: ALIAS_CONFIG_INVALID_ORIGINAL_END_IP - - code: ALIAS_CONFIG_REPLACE_IP_ADDRESS_MISSING - - code: INVALID_DNSREBIND_REBIND_DOMAINS_LIST_CONFIG - - code: INVALID_TRUSTANCHOR_KEY_TAG_RANGE_CONFIG - - code: INVALID_TRUSTANCHOR_KEY_DIGEST_ALGO_RANGE_CONFIG - - code: INVALID_TRUSTANCHOR_KEY_DIGEST_TYPE_RANGE_CONFIG - - code: INVALID_DOMAINTOADDRESS_DOMAIN_NAMES_LIST_CONFIG - - code: DOMAINTOADDRESS_IP_CONFIG_MISSING - - code: INVALID_SECONDARY_SERVER - - code: INVALID_PEER_ADDRESS - - code: AUTHCONFIG_SERVER_DOMAIN_NAME_CONFIG_MISSING - - code: AUTHCONFIG_SERVER_DOMAIN_NAME_CONFIG_INVALID_HOST - - code: AUTHCONFIG_ZONE_DOMAIN_NAME_CONFIG_MISSING - - code: AUTHCONFIG_ZONE_DOMAIN_NAME_CONFIG_INVALID_HOST - - code: AUTHCONFIG_ZONE_INVALID_INCLUDE_PREFIX - - code: AUTHCONFIG_ZONE_INVALID_EXCLUDE_PREFIX - - code: AUTHCONFIG_SOA_SERIAL_NUMBER_CONFIG_MISSING - - code: INVALID_HOSTRECORD_DOMAIN_NAMES_LIST_CONFIG - - code: INVALID_HOSTRECORD_IPV4_CONFIG - - code: INVALID_HOSTRECORD_IPV6_CONFIG - - code: SYNTHDOMAIN_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: INVALID_SYNTHDOMAIN_START_IP_ADDRESS_CONFIG - - code: INVALID_SYNTHDOMAIN_END_IP_ADDRESS_CONFIG - - code: INVALID_SYNTHDOMAIN_IP_ADDRESS_PREFIX_CONFIG - - code: SRVHOST_SERVICE_MISSING - - code: SRVHOST_PROTOCOL_MISSING - - code: SRVHOST_DOMAIN_NAME_CONFIG_INVALID_HOST - - code: INVALID_SRVHOST_PORT_RANGE_CONFIG - - code: INVALID_SRVHOST_PRIORITY_RANGE_CONFIG - - code: NAPTRRECORD_NAME_MISSING - - code: INVALID_NAPTRRECORD_ORDER_RANGE_CONFIG - - code: NAPTRRECORD_ORDER_MISSING - - code: INVALID_NAPTRRECORD_PREFERENCE_RANGE_CONFIG - - code: NAPTRRECORD_PREFERENCE_MISSING - - code: NAPTRRECORD_FLAGS_MISSING - - code: CAARECORD_NAME_MISSING - - code: CAARECORD_FLAG_MISSING - - code: CAARECORD_TAG_MISSING - - code: CAARECORD_VALUE_MISSING - - code: DNSRESOURCERECORD_NAME_MISSING - - code: DNSRESOURCERECORD_RRNUMBER_MISSING - - code: CNAMERECORD_NAME_MISSING - - code: CNAMERECORD_TARGET_MISSING - - code: PTRRECORD_NAME_MISSING - - code: TXTRECORD_DOMAIN_NAME_MISSING - - code: TXTRECORD_TEXT_INVALID_LENGTH - - code: MX_NAME_MISSING - - code: MX_HOST_NAME_MISSING - - code: MX_NAME_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: INVALID_DNSSERVER_IP_CONFIG_IPV6 - - code: INVALID_DNSSERVER_IPV6_PREFIX_CONFIG - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update DNS Service Profile (v2.1) - tags: - - DNS Services servers: - url: https://api.us.cloudgenix.com tags: diff --git a/openapi-specs/sdwan/legacy/DeviceConfiguration.yaml b/openapi-specs/sdwan/legacy/DeviceConfiguration.yaml index 66a5a40b1..52442ebc4 100644 --- a/openapi-specs/sdwan/legacy/DeviceConfiguration.yaml +++ b/openapi-specs/sdwan/legacy/DeviceConfiguration.yaml @@ -53,21 +53,9 @@ components: 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: @@ -77,28 +65,6 @@ components: - 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 ApplicationProbe: properties: description: @@ -170,28 +136,60 @@ components: type: array required: - name - AuthenticationInterfaceConfig: + AuthenticationConfig: properties: - fallback_retry_count: - description: 'The fallback retry count. The fall back to MAC Auth if the - client is not using 802.1x authentication. - - ' - type: integer mode: - description: 'The auth mode. - - ' + description: 'Mode: ValidateEnum(enumClass = classOf[AuthenticationType], + error = INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_MAC_AUTH_TYPE: Invalid + interface configuration. Invalid dot1x type. Valid values are none, mac_auth + and dot1x., nullAllowed = false) ' enum: - none - dot1x - macauth - - dot1x-to-macauth-fallback type: string reauthentication_timeout: - description: 'Reauthentication timeout value. + description: 'Reauthentication Timeout: Range(max = 86400L, error = INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_REAUTH_TIMEOUT: + Invalid interface configuration. Invalid dot1x reauth timeout. Valid values + are 30 - 86400., min = 30L) ' + type: integer + required: + - mode + 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 BaseQuery: properties: @@ -296,6 +294,23 @@ components: wan_interface_id: description: 'The WAN interface ID. + ' + type: string + BypassPair: + properties: + lan: + description: 'Bypass port is connected to a LAN network. + + ' + type: string + use_relay: + description: 'The DHCP relay is selected to Yes. + + ' + type: boolean + wan: + description: 'Bypass port is connected to a WAN network. + ' type: string BypassPairV2: @@ -333,15 +348,6 @@ 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: @@ -606,177 +612,333 @@ components: type: string required: - site_id - ElementImageStatus: + ElementAggregateQueryFilterV2N5: properties: - active_image_id: - description: 'The active image ID. - - ' - type: string - failure_info: - description: 'The element image failure information. - - ' - type: string - id: - description: 'The ID. - - ' - type: string - previous_image_id: - description: 'The previous image ID. - - ' - type: string - upgrade_image_id: - description: 'The upgrade image ID. - - ' - type: string - upgrade_state: - description: 'The upgrade state of the element. - - ' + admin_action: + description: Admin Action enum: - - pending - - init - - discovery - - download - - download_init - - download_complete - - download_scheduled - - download_abort - - download_cancelled - - download_cancel_pending - - upgrade - - upgrade_init - - upgrade_complete - - upgrade_scheduled - - upgrade_abort - - upgrade_cancelled - - upgrade_cancel_pending - - upgrade_failed - - upgrading - - verify - - in-progress - - install - - complete - - done - - failed - - download_discovery - - download_failed - - downloading - - install_failed - - installing - - verifying - - waiting_download_time - - waiting_install_time - - abort_upgrade_pending - - abort_download_pending - - invalid + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID type: string - ElementImageStatusQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of element image status that match the - query parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number of element image status deleted for a time frame. - - ' - type: boolean - group_by: - description: 'Group the element image status for the query. - - ' - items: - description: Group By - type: string - type: array - id: - description: "List the element image status by ID. \n" + admin_renew_state: + description: Admin Renew State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION 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 + admin_suspend_state: + description: Admin Suspend State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION + type: string + aggregated_value: + description: Aggregated Value + format: int64 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. - - ' + allowed_roles: + description: Allowed Roles items: - description: Retrieved Fields + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string type: array - retrieved_fields_mask: - description: 'List the fields to query. - - ' + cluster_insertion_mode: + description: Cluster Insertion Mode + type: string + cluster_member_id: + description: Cluster Member Id + type: string + connected: + description: Connected 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. - - ' + 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 + fips_mode: + description: Fips Mode + enum: + - none + - fips + - non_fips + type: string + fips_mode_change_start_time: + description: Fips Mode Change Start Time format: int64 type: integer - ElementImageStatusQueryFilterV2N1: + hw_id: + description: Hw Id + type: string + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + model_name: + description: Model Name + type: string + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + 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.) ' + 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) ' + 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) ' + type: string + role: + description: Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + 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_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + 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 + 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) ' + items: + description: Tags + 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 + type: boolean + required: + - tenant_id + - site_id + ElementImageStatus: properties: active_image_id: description: 'The active image ID. ' type: string - active_version: - description: 'The active version. - - ' - type: string - download_interval: - description: 'The download interval. - - ' - type: integer - download_percent: - description: 'The download percentage. - - ' - type: integer - element_id: - description: Element Id - type: string failure_info: description: 'The element image failure information. @@ -790,21 +952,6 @@ components: previous_image_id: description: 'The previous image ID. - ' - type: string - rollback_version: - description: 'The rollback version. - - ' - type: string - scheduled_download: - description: 'The scheduled download. - - ' - type: string - scheduled_upgrade: - description: 'The scheduled upgrade. - ' type: string upgrade_image_id: @@ -812,9 +959,6 @@ components: ' type: string - upgrade_interval: - description: "The upgrade interval. \n" - type: integer upgrade_state: description: 'The upgrade state of the element. @@ -857,7 +1001,189 @@ components: - abort_download_pending - invalid type: string - ElementImageStatusV2N1: + ElementImageStatusQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of element image status that match the + query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of element image status deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the element image status for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the element image status 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 + ElementImageStatusQueryFilterV2N1: + properties: + active_image_id: + description: 'The active image ID. + + ' + type: string + active_version: + description: 'The active version. + + ' + type: string + download_interval: + description: 'The download interval. + + ' + type: integer + download_percent: + description: 'The download percentage. + + ' + type: integer + element_id: + description: Element Id + type: string + failure_info: + description: 'The element image failure information. + + ' + type: string + id: + description: 'The ID. + + ' + type: string + previous_image_id: + description: 'The previous image ID. + + ' + type: string + rollback_version: + description: 'The rollback version. + + ' + type: string + scheduled_download: + description: 'The scheduled download. + + ' + type: string + scheduled_upgrade: + description: 'The scheduled upgrade. + + ' + type: string + upgrade_image_id: + description: 'The upgrade image ID. + + ' + type: string + upgrade_interval: + description: "The upgrade interval. \n" + type: integer + upgrade_state: + description: 'The upgrade state of the element. + + ' + enum: + - pending + - init + - discovery + - download + - download_init + - download_complete + - download_scheduled + - download_abort + - download_cancelled + - download_cancel_pending + - upgrade + - upgrade_init + - upgrade_complete + - upgrade_scheduled + - upgrade_abort + - upgrade_cancelled + - upgrade_cancel_pending + - upgrade_failed + - upgrading + - verify + - in-progress + - install + - complete + - done + - failed + - download_discovery + - download_failed + - downloading + - install_failed + - installing + - verifying + - waiting_download_time + - waiting_install_time + - abort_upgrade_pending + - abort_download_pending + - invalid + type: string + ElementImageStatusV2N1: properties: active_image_id: description: 'The active image ID. @@ -1029,12 +1355,10 @@ components: description: Total Count format: int64 type: integer - ElementQueryFilterV3: + ElementQueryFilter: properties: admin_action: - description: 'The values of admin actions that can be performed. - - ' + description: "The values of admin actions that can be performed. \n" enum: - ALLOCATE - CLAIM @@ -1050,177 +1374,34 @@ components: - DEFAULT - INVALID type: string - admin_renew_state: - description: 'The values of admin renew state. - - ' - enum: - - SLEEP - - INIT - - ACTIVE - - ACTIVE_ASSIGNED_DEFAULT - - ACTIVE_ASSIGNED_TENANT - - ACTIVE_TRUSTED - - ACTIVE_NOCERT - - ACTIVE_CLAIMED - - ACTIVE_MIC - - ACTIVE_MIC_PENDING - - ACTIVE_MIC_ISSUED - - ACTIVE_MIC_FAILED - - ACTIVE_CIC - - ACTIVE_CIC_SITE - - ACTIVE_CIC_PENDING - - ACTIVE_CIC_ISSUED - - ACTIVE_CIC_FAILED - - ACTIVE_INVENTORY_IN_PROGRESS - - ACTIVE_INVENTORY_GET_PENDING - - ACTIVE_INVENTORY_POST_PENDING - - ACTIVE_INVENTORY_GET_COMPLETE - - ACTIVE_INVENTORY_GET_FAILED - - ACTIVE_INVENTORY_OPERATION_FAILED - - ACTIVE_INTF_CONFIG_GET_PENDING - - ACTIVE_INTF_CONFIG_GET_COMPLETE - - ACTIVE_INTF_CONFIG_GET_FAILED - - ACTIVE_INTF_STATE_GET_PENDING - - ACTIVE_INTF_STATE_GET_COMPLETE - - ACTIVE_INTF_STATE_GET_FAILED - - ACTIVE_BOUND_TO_SITE_PENDING - - ACTIVE_BOUND_TO_SITE - - ACTIVE_BOUND_TO_SITE_FAILED - - ACTIVE_READY - - ACTIVE_RENEW_PENDING - - ACTIVE_RENEWED - - ACTIVE_DECLAIM_IN_PROGRESS - - ACTIVE_DECLAIMED - - ACTIVE_UNBOUND_FROM_SITE - - ACTIVE_UNBOUND_IN_PROGRESS - - ACTIVE_UNBOUND_FROM_SITE_FAILED - - ACTIVE_CIC_CERTIFICATE_CHECK - - ACTIVE_MONITORING - - ACTIVE_CONNECTED - - ACTIVE_24_HOURS_LESS - - ACTIVE_24_HOURS_MORE - - ACTIVE_TROUBLESHOOT - - ACTIVE_SUSPEND_INIT - - ACTIVE_SUSPEND_IN_PROGRESS - - ACTIVE_SUSPENDED - - ACTIVE_SUSPEND_FAILED - - ACTIVE_SUSPEND_FAILED_TIMEOUT - - ACTIVE_SUSPENDED_MIC_OPERATIONAL - - ACTIVE_SUSPENDED_CIC_OPERATIONAL - - ACTIVE_SUSPENDED_EMPTY_TOKEN - - ACTIVE_SUSPENDED_TOKEN_EXPIRED - - INACTIVE_NOCERT - - INACTIVE_MIC - - INACTIVE_CIC - - INACTIVE_CIC_SITE - - RETURNED - - STANDBY - - OOS_AT_READY - - OOS_AT_INIT - - OOS_AT_BIND_PENDING - - OOS_AT_BIND - - OOS_AT_BIND_FAILED - - OOS_AT_UNBIND_FAILED - - OOS_AT_UNBIND_PROGRESS - - DECOMMISSION - type: string - admin_suspend_state: - description: "The values of the admin suspend state. \n" - enum: - - SLEEP - - INIT - - ACTIVE - - ACTIVE_ASSIGNED_DEFAULT - - ACTIVE_ASSIGNED_TENANT - - ACTIVE_TRUSTED - - ACTIVE_NOCERT - - ACTIVE_CLAIMED - - ACTIVE_MIC - - ACTIVE_MIC_PENDING - - ACTIVE_MIC_ISSUED - - ACTIVE_MIC_FAILED - - ACTIVE_CIC - - ACTIVE_CIC_SITE - - ACTIVE_CIC_PENDING - - ACTIVE_CIC_ISSUED - - ACTIVE_CIC_FAILED - - ACTIVE_INVENTORY_IN_PROGRESS - - ACTIVE_INVENTORY_GET_PENDING - - ACTIVE_INVENTORY_POST_PENDING - - ACTIVE_INVENTORY_GET_COMPLETE - - ACTIVE_INVENTORY_GET_FAILED - - ACTIVE_INVENTORY_OPERATION_FAILED - - ACTIVE_INTF_CONFIG_GET_PENDING - - ACTIVE_INTF_CONFIG_GET_COMPLETE - - ACTIVE_INTF_CONFIG_GET_FAILED - - ACTIVE_INTF_STATE_GET_PENDING - - ACTIVE_INTF_STATE_GET_COMPLETE - - ACTIVE_INTF_STATE_GET_FAILED - - ACTIVE_BOUND_TO_SITE_PENDING - - ACTIVE_BOUND_TO_SITE - - ACTIVE_BOUND_TO_SITE_FAILED - - ACTIVE_READY - - ACTIVE_RENEW_PENDING - - ACTIVE_RENEWED - - ACTIVE_DECLAIM_IN_PROGRESS - - ACTIVE_DECLAIMED - - ACTIVE_UNBOUND_FROM_SITE - - ACTIVE_UNBOUND_IN_PROGRESS - - ACTIVE_UNBOUND_FROM_SITE_FAILED - - ACTIVE_CIC_CERTIFICATE_CHECK - - ACTIVE_MONITORING - - ACTIVE_CONNECTED - - ACTIVE_24_HOURS_LESS - - ACTIVE_24_HOURS_MORE - - ACTIVE_TROUBLESHOOT - - ACTIVE_SUSPEND_INIT - - ACTIVE_SUSPEND_IN_PROGRESS - - ACTIVE_SUSPENDED - - ACTIVE_SUSPEND_FAILED - - ACTIVE_SUSPEND_FAILED_TIMEOUT - - ACTIVE_SUSPENDED_MIC_OPERATIONAL - - ACTIVE_SUSPENDED_CIC_OPERATIONAL - - ACTIVE_SUSPENDED_EMPTY_TOKEN - - ACTIVE_SUSPENDED_TOKEN_EXPIRED - - INACTIVE_NOCERT - - INACTIVE_MIC - - INACTIVE_CIC - - INACTIVE_CIC_SITE - - RETURNED - - STANDBY - - OOS_AT_READY - - OOS_AT_INIT - - OOS_AT_BIND_PENDING - - OOS_AT_BIND - - OOS_AT_BIND_FAILED - - OOS_AT_UNBIND_FAILED - - OOS_AT_UNBIND_PROGRESS - - DECOMMISSION - 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_id: - description: "The spoke HA config cluster ID. \n" - type: string - connected: - description: 'The element is connected. True or False. - - ' - type: boolean - deployment_op: - description: 'The deployment values. + 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: 'The cluster member ID. + + ' + type: string + connected: + description: 'The element is connected. True or False. + + ' + type: boolean + deployment_op: + description: 'The deployment values. ' enum: @@ -1242,29 +1423,16 @@ components: - GET_MAC_ADDRESS_TABLE type: string description: - description: 'The description of the element. - - ' - device_profile_id: - description: 'The device profile ID. - - ' - type: string - fips_mode: - description: 'The FIPs mode. + description: 'The description of the element. Max length = 256. ' - enum: - - none - - fips - - non_fips - type: string - fips_mode_change_start_time: - description: 'The FIPs mode change starting time. + events: + description: 'The details of the events occurred. ' - format: int64 - type: integer + items: + $ref: '#/components/schemas/BaseEventState' + type: array hw_id: description: 'The hardware ID. @@ -1273,59 +1441,11 @@ components: id: description: Id type: string - l3_direct_private_wan_forwarding: - description: 'The L3 direct private WAN is enabled. True or False. - - ' - type: boolean - 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: 'Valid LED config. - - ' - main_power_usage_threshold: - description: "The main power usage threshold. Allowed range is 50-100. \ - \ \n" - format: int32 - type: integer model_name: - description: "The model name of the device. \n" + description: "The model name of the device. \n" type: string name: - description: 'The name of the device. - - ' - type: string - 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. - - ' - type: string - override_indicator: - description: 'The override indicator. - - ' - items: - description: Override Indicator - type: string - type: array - priority_policysetstack_id: - description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack - API. + description: 'The name of the element. Max length = 128. ' type: string @@ -1334,12 +1454,12 @@ components: ' enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - PA_WE_DC + - PA_WE_BR + - NONE - PA_CONN + - SPOKE + - HUB type: string serial_number: description: 'The serial number. @@ -1356,11 +1476,16 @@ components: ' type: string - spoke_ha_config: - $ref: '#/components/schemas/SpokeHAConfigV2' - description: 'The details of the spoke HA configuration. + spoke_cluster_status: + description: 'The spoke cluster status. ' + enum: + - init + - active + - backup + - unknown + type: string state: description: 'The element state. @@ -1383,38 +1508,12 @@ components: - OOS - ACTIVE_DECLAIM_IN_PROGRESS type: string - switch_config: - $ref: '#/components/schemas/SwitchConfig' - description: 'The details of the switch configuration. - - ' - tags: - description: 'A information field that can be added to identify the element. - - ' - items: - description: Tags - type: string - type: array - tenant_id: - description: 'The tenant ID. - - ' - type: string - vpn_to_vpn_forwarding: - description: 'VPN to VPN forwarding. True or False. - - ' - type: boolean required: - site_id - - tenant_id - ElementQueryFilterV3N1: + ElementQueryFilterV2N1: properties: admin_action: - description: 'The values of admin actions that can be performed. - - ' + description: "The values of admin actions that can be performed. \n" enum: - ALLOCATE - CLAIM @@ -1430,154 +1529,6 @@ components: - DEFAULT - INVALID type: string - admin_renew_state: - description: 'The values of admin renew state. - - ' - enum: - - SLEEP - - INIT - - ACTIVE - - ACTIVE_ASSIGNED_DEFAULT - - ACTIVE_ASSIGNED_TENANT - - ACTIVE_TRUSTED - - ACTIVE_NOCERT - - ACTIVE_CLAIMED - - ACTIVE_MIC - - ACTIVE_MIC_PENDING - - ACTIVE_MIC_ISSUED - - ACTIVE_MIC_FAILED - - ACTIVE_CIC - - ACTIVE_CIC_SITE - - ACTIVE_CIC_PENDING - - ACTIVE_CIC_ISSUED - - ACTIVE_CIC_FAILED - - ACTIVE_INVENTORY_IN_PROGRESS - - ACTIVE_INVENTORY_GET_PENDING - - ACTIVE_INVENTORY_POST_PENDING - - ACTIVE_INVENTORY_GET_COMPLETE - - ACTIVE_INVENTORY_GET_FAILED - - ACTIVE_INVENTORY_OPERATION_FAILED - - ACTIVE_INTF_CONFIG_GET_PENDING - - ACTIVE_INTF_CONFIG_GET_COMPLETE - - ACTIVE_INTF_CONFIG_GET_FAILED - - ACTIVE_INTF_STATE_GET_PENDING - - ACTIVE_INTF_STATE_GET_COMPLETE - - ACTIVE_INTF_STATE_GET_FAILED - - ACTIVE_BOUND_TO_SITE_PENDING - - ACTIVE_BOUND_TO_SITE - - ACTIVE_BOUND_TO_SITE_FAILED - - ACTIVE_READY - - ACTIVE_RENEW_PENDING - - ACTIVE_RENEWED - - ACTIVE_DECLAIM_IN_PROGRESS - - ACTIVE_DECLAIMED - - ACTIVE_UNBOUND_FROM_SITE - - ACTIVE_UNBOUND_IN_PROGRESS - - ACTIVE_UNBOUND_FROM_SITE_FAILED - - ACTIVE_CIC_CERTIFICATE_CHECK - - ACTIVE_MONITORING - - ACTIVE_CONNECTED - - ACTIVE_24_HOURS_LESS - - ACTIVE_24_HOURS_MORE - - ACTIVE_TROUBLESHOOT - - ACTIVE_SUSPEND_INIT - - ACTIVE_SUSPEND_IN_PROGRESS - - ACTIVE_SUSPENDED - - ACTIVE_SUSPEND_FAILED - - ACTIVE_SUSPEND_FAILED_TIMEOUT - - ACTIVE_SUSPENDED_MIC_OPERATIONAL - - ACTIVE_SUSPENDED_CIC_OPERATIONAL - - ACTIVE_SUSPENDED_EMPTY_TOKEN - - ACTIVE_SUSPENDED_TOKEN_EXPIRED - - INACTIVE_NOCERT - - INACTIVE_MIC - - INACTIVE_CIC - - INACTIVE_CIC_SITE - - RETURNED - - STANDBY - - OOS_AT_READY - - OOS_AT_INIT - - OOS_AT_BIND_PENDING - - OOS_AT_BIND - - OOS_AT_BIND_FAILED - - OOS_AT_UNBIND_FAILED - - OOS_AT_UNBIND_PROGRESS - - DECOMMISSION - type: string - admin_suspend_state: - description: "The values of the admin suspend state. \n" - enum: - - SLEEP - - INIT - - ACTIVE - - ACTIVE_ASSIGNED_DEFAULT - - ACTIVE_ASSIGNED_TENANT - - ACTIVE_TRUSTED - - ACTIVE_NOCERT - - ACTIVE_CLAIMED - - ACTIVE_MIC - - ACTIVE_MIC_PENDING - - ACTIVE_MIC_ISSUED - - ACTIVE_MIC_FAILED - - ACTIVE_CIC - - ACTIVE_CIC_SITE - - ACTIVE_CIC_PENDING - - ACTIVE_CIC_ISSUED - - ACTIVE_CIC_FAILED - - ACTIVE_INVENTORY_IN_PROGRESS - - ACTIVE_INVENTORY_GET_PENDING - - ACTIVE_INVENTORY_POST_PENDING - - ACTIVE_INVENTORY_GET_COMPLETE - - ACTIVE_INVENTORY_GET_FAILED - - ACTIVE_INVENTORY_OPERATION_FAILED - - ACTIVE_INTF_CONFIG_GET_PENDING - - ACTIVE_INTF_CONFIG_GET_COMPLETE - - ACTIVE_INTF_CONFIG_GET_FAILED - - ACTIVE_INTF_STATE_GET_PENDING - - ACTIVE_INTF_STATE_GET_COMPLETE - - ACTIVE_INTF_STATE_GET_FAILED - - ACTIVE_BOUND_TO_SITE_PENDING - - ACTIVE_BOUND_TO_SITE - - ACTIVE_BOUND_TO_SITE_FAILED - - ACTIVE_READY - - ACTIVE_RENEW_PENDING - - ACTIVE_RENEWED - - ACTIVE_DECLAIM_IN_PROGRESS - - ACTIVE_DECLAIMED - - ACTIVE_UNBOUND_FROM_SITE - - ACTIVE_UNBOUND_IN_PROGRESS - - ACTIVE_UNBOUND_FROM_SITE_FAILED - - ACTIVE_CIC_CERTIFICATE_CHECK - - ACTIVE_MONITORING - - ACTIVE_CONNECTED - - ACTIVE_24_HOURS_LESS - - ACTIVE_24_HOURS_MORE - - ACTIVE_TROUBLESHOOT - - ACTIVE_SUSPEND_INIT - - ACTIVE_SUSPEND_IN_PROGRESS - - ACTIVE_SUSPENDED - - ACTIVE_SUSPEND_FAILED - - ACTIVE_SUSPEND_FAILED_TIMEOUT - - ACTIVE_SUSPENDED_MIC_OPERATIONAL - - ACTIVE_SUSPENDED_CIC_OPERATIONAL - - ACTIVE_SUSPENDED_EMPTY_TOKEN - - ACTIVE_SUSPENDED_TOKEN_EXPIRED - - INACTIVE_NOCERT - - INACTIVE_MIC - - INACTIVE_CIC - - INACTIVE_CIC_SITE - - RETURNED - - STANDBY - - OOS_AT_READY - - OOS_AT_INIT - - OOS_AT_BIND_PENDING - - OOS_AT_BIND - - OOS_AT_BIND_FAILED - - OOS_AT_UNBIND_FAILED - - OOS_AT_UNBIND_PROGRESS - - DECOMMISSION - type: string allowed_roles: description: "The allowed roles. \n" items: @@ -1591,11 +1542,16 @@ components: - PA_CONN type: string type: array - cluster_id: - description: Cluster Id + cluster_insertion_mode: + description: "The cluster insertion mode. \n" + type: string + cluster_member_id: + description: 'The cluster member ID. + + ' type: string connected: - description: 'The element is connected. True or False. + description: 'The device is connected. True or False. ' type: boolean @@ -1622,53 +1578,11 @@ components: - GET_MAC_ADDRESS_TABLE type: string description: - 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. - - ' - type: string - fips_mode: - description: 'The FIPs mode. - - ' - enum: - - none - - fips - - non_fips - type: string - fips_mode_change_start_time: - description: 'The FIPs mode change starting time. + description: 'The description of the element filter. ' - format: int64 - type: integer hw_id: - description: 'The hardware ID. - - ' + description: "The hardware ID. \n" type: string id: description: Id @@ -1685,49 +1599,23 @@ components: ' type: boolean - led_config: - $ref: '#/components/schemas/LedConfig' - description: 'Valid LED config. - - ' - main_power_usage_threshold: - description: "The main power usage threshold. Allowed range is 50-100. \ - \ \n" - format: int32 - type: integer model_name: description: "The model name of the device. \n" type: string name: description: 'The name of the device. - ' - type: string - 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: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - override_indicator: - description: 'The override indicator. - - ' - items: - description: Override Indicator - type: string - type: array priority_policysetstack_id: - description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack - API. - - ' + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string role: description: 'The element role. @@ -1756,11 +1644,6 @@ components: ' type: string - spoke_ha_config: - $ref: '#/components/schemas/SpokeHAConfigV2' - description: 'The details of the spoke HA configuration. - - ' state: description: 'The element state. @@ -1783,209 +1666,154 @@ components: - OOS - ACTIVE_DECLAIM_IN_PROGRESS type: string - switch_config: - $ref: '#/components/schemas/SwitchConfig' - description: 'The details of the switch configuration. - - ' - tags: - description: 'A information field that can be added to identify the element. - - ' - items: - description: Tags - type: string - type: array tenant_id: - description: 'The 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. \n" - type: boolean required: - site_id - tenant_id - ElementScreenV3: + ElementQueryFilterV2N2: properties: - cluster_id: - description: "The cluster ID. \n" + admin_action: + description: Admin Action + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID type: string - description: - description: 'The description of the element. - - ' - device_profile_id: - description: "The device profile ID. \n" - type: string - id: - description: "The element ID. \n" - type: string - l3_direct_private_wan_forwarding: - description: 'The L3 direct private WAN is enabled. True or False. - - ' - type: boolean - 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: 'Valid LED config. - - ' - main_power_usage_threshold: - description: "The main power usage threshold. Allowed range is 50-100. \ - \ \n" - format: int32 - type: integer - name: - description: 'The name of the device. - - ' - type: string - 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. - - ' - type: string - priority_policysetstack_id: - description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack - API. - - ' - type: string - site_id: - description: "The site ID. \n" - type: string - spoke_ha_config: - $ref: '#/components/schemas/SpokeHAConfigV2' - description: 'The details of the spoke HA configuration. - - ' - sw_obj: - $ref: '#/components/schemas/Software' - description: 'The location and version of the software. - - ' - switch_config: - $ref: '#/components/schemas/SwitchConfig' - description: 'The details of the switch configuration. - - ' - tags: - description: 'A information field that can be added to identify the element. - - ' + allowed_roles: + description: Allowed Roles items: - description: Tags + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string type: array - tenant_id: - description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - vpn_to_vpn_forwarding: - description: 'VPN to VPN forwarding. True or False. - - ' + cluster_member_id: + description: Cluster Member Id + type: string + connected: + description: Connected type: boolean - required: - - site_id - - tenant_id - ElementScreenV3N1: - properties: - cluster_id: - description: "The cluster ID. \n" + 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: 'The description of the element. - - ' - device_profile_id: - description: "The device profile ID. \n" + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + hw_id: + description: Hw Id type: string id: - description: "The element ID. \n" + description: Id type: string l3_direct_private_wan_forwarding: - description: 'The L3 direct private WAN is enabled. True or False. - - ' + description: L3 Direct Private Wan Forwarding type: boolean 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. - - ' + description: L3 Lan Forwarding type: boolean - led_config: - $ref: '#/components/schemas/LedConfig' - description: 'Valid LED config. - - ' - main_power_usage_threshold: - description: "The main power usage threshold. Allowed range is 50-100. \ - \ \n" - format: int32 - type: integer - name: - description: 'The name of the device. - - ' + model_name: + description: Model Name type: string - nat_policysetstack_id: - description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack - API. - - ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string network_policysetstack_id: - description: 'The ID for the Path Policyset Stack. Can be retrieved using - networkpolicysetstack API. - - ' + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string priority_policysetstack_id: - description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack - API. - - ' + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' + type: string + role: + description: Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + serial_number: + description: Serial Number type: string site_id: - description: "The site ID. \n" + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + software_version: + description: Software Version type: string spoke_ha_config: - $ref: '#/components/schemas/SpokeHAConfigV2' - description: 'The details of the spoke HA configuration. - - ' - sw_obj: - $ref: '#/components/schemas/Software' - description: 'The location and version of the software. - - ' - switch_config: - $ref: '#/components/schemas/SwitchConfig' - description: 'The details of the switch configuration. - - ' + $ref: '#/components/schemas/SpokeHAConfigV1' + description: 'Spoke Ha Config: Valid ' + 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 tags: - description: 'A information field that can be added to identify the element. - - ' + 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) ' items: description: Tags type: string @@ -1993,730 +1821,494 @@ components: 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. - - ' - type: boolean required: - site_id - tenant_id - ElementSoftwareState: + ElementQueryFilterV2N3: properties: - download_interval: - description: 'The software download interval. Valid download interval must - be provided along with a valid download time. - - ' - type: integer - id: - description: 'The ID. - - ' - type: string - image_id: - description: 'The element image ID. - - ' + admin_action: + description: Admin Action + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID type: string - interface_ids: - description: 'The software interface IDs. - - ' - items: - description: Interface Ids - type: string + admin_renew_state: + description: Admin Renew State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION + type: string + allowed_roles: + description: Allowed Roles + items: + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string type: array - scheduled_download: - description: 'The scheduled download. - - ' + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - scheduled_upgrade: - description: 'The scheduled upgrade. - - ' + 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 + hw_id: + description: Hw Id type: string - upgrade_interval: - description: 'The upgrade interval of the firmware. Valid upgrade interval - must be provided along with a valid upgrade time. - - ' - type: integer - ElementSoftwareStateScreen: - properties: - download_interval: - description: 'The software download interval. Valid download interval must - be provided along with a valid download time. - - ' - type: integer id: - description: 'The ID. - - ' + description: Id type: string - image_id: - description: 'The element image ID. - - ' + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + model_name: + description: Model Name type: string - interface_ids: - description: 'The software interface IDs. - - ' - items: - description: Interface Ids - type: string - type: array - scheduled_download: - description: 'The scheduled download. - - ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - scheduled_upgrade: - description: 'The scheduled upgrade. - - ' + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string - upgrade_interval: - description: 'The upgrade interval of the firmware. Valid upgrade interval - must be provided along with a valid upgrade time. - - ' - type: integer - ElementState: - properties: - id: - description: 'The ID. - - ' + network_policysetstack_id: + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - image_id: - description: 'The element image ID. - - ' + priority_policysetstack_id: + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string - scheduled_upgrade: - description: 'The scheduled upgrade. - - ' + role: + description: Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - ElementStateQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of element states that match the query - parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number element states deleted for a time frame. - - ' - type: boolean - group_by: - description: 'Group the element states for the query. - - ' + 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_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV1' + description: 'Spoke Ha Config: Valid ' + 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 + 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) ' items: - description: Group By + description: Tags type: string type: array - id: - description: "List the element state by ID. \n" + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' 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. - - ' + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding + type: boolean + required: + - site_id + - tenant_id + ElementQueryFilterV2N4: + properties: + admin_action: + description: Admin Action + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID + type: string + admin_renew_state: + description: Admin Renew State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION + type: string + allowed_roles: + description: Allowed Roles items: - description: Retrieved Fields + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string type: array - retrieved_fields_mask: - description: 'List the fields to query. - - ' + cluster_insertion_mode: + description: Cluster Insertion Mode + type: string + cluster_member_id: + description: Cluster Member Id + type: string + connected: + description: Connected 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 - ElementStateQueryFilter: - properties: + 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 + hw_id: + description: Hw Id + type: string id: - description: 'The ID. - - ' + description: Id type: string - image_id: - description: 'The element image ID. - - ' + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + model_name: + description: Model Name type: string - scheduled_download: - description: 'The scheduled download. - - ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - scheduled_upgrade: - description: 'The scheduled upgrade. - - ' + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string - ElementStateScreen: - properties: - id: - description: 'The ID. - - ' + network_policysetstack_id: + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - image_id: - description: 'The element image ID. - - ' + priority_policysetstack_id: + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string - scheduled_upgrade: - description: 'The scheduled upgrade. - - ' + role: + description: Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - ElementStatusQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of element status that match the query - parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number element status deleted for a time frame. - - ' - type: boolean - group_by: - description: 'Group the element status for the query. - - ' - items: - description: Group By - type: string - type: array - id: - description: "List the element status by ID. \n" + serial_number: + description: Serial Number 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 - ElementStatusV2N2: - properties: - analytics_backlog_connected: - description: 'The analytics backlog is connected. True or False. - - ' - type: boolean - analytics_backlog_connected_on_utc: - description: 'The analytics backlog is connected on utc. - - ' - format: int64 - type: integer - analytics_backlog_disconnected_on_utc: - description: "The analytics backlog is disconnected on utc. \n" - format: int64 - type: integer - analytics_backlog_from: - description: 'The IPv4 address of the analytics backlog. - - ' - type: string - analytics_live_connected: - description: "The live analytics is connected. True or False. \n" - type: boolean - analytics_live_connected_on_utc: - description: "The live analytics is connected on utc. \n" - format: int64 - type: integer - analytics_live_disconnected_on_utc: - description: 'The live analytics is disconnected on utc. - - ' - format: int64 - type: integer - analytics_live_from: - description: 'The IPv4 address of the live analytics. - - ' - type: string - config_and_events_connected: - description: "The config and events are connected. True or False. \n" - type: boolean - 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: "The config and events are disconnected on utc. \n" - format: int64 - type: integer - config_and_events_from: - description: 'The IPv4 address for config and events. - - ' - type: string - element_id: - description: "The element ID. \n" - type: string - flows_backlog_connected: - description: "The flows backlog is connected. True or False. \n" - type: boolean - flows_backlog_connected_on_utc: - description: 'The flows backlog is connected on utc. - - ' - format: int64 - type: integer - flows_backlog_disconnected_on_utc: - description: "The flows backlog is disconnected on utc. \n" - format: int64 - type: integer - flows_backlog_from: - description: 'The IPv4 address of the flow backlog. - - ' - type: string - flows_live_connected: - description: "The live flows is connected. True or False. \n" - type: boolean - flows_live_connected_on_utc: - description: 'The live flows are connected on utc. - - ' - format: int64 - type: integer - flows_live_disconnected_on_utc: - description: "The live flows are disconnected on utc. \n" - format: int64 - type: integer - flows_live_from: - description: 'The IPV4 address of live flows. - - ' - type: string - 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: 'The backlog logs are connected. True or False. - - ' - type: boolean - logs_backlog_connected_on_utc: - description: "The backlog logs are connected on utc. \n" - format: int64 - type: integer - logs_backlog_disconnected_on_utc: - description: 'The backlog logs disconnected on utc. - - ' - format: int64 - type: integer - logs_backlog_from: - description: 'The IPV4 address for logs backlog. - - ' - type: string - logs_live_connected: - 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: 'The live logs are disconnected on utc. - - ' - format: int64 - type: integer - logs_live_from: - description: "The IPv4 address from the live logs. \n" + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' type: string - main_max_power_supported: - description: 'The main max power supported. - - ' - format: int32 - type: integer - main_power_allocated: - description: 'The main power allocated. - - ' - format: float - type: number - main_power_usage_threshold: - description: "The main power usage threshold. \n" - format: int32 - type: integer - poe_state: - description: 'The poe_state. - - ' + software_version: + description: Software Version type: string - site_id: - description: "The site ID. \n" + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + 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 - switch_state: - $ref: '#/components/schemas/SwitchState' - description: 'The switch state. - - ' + 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) ' + items: + description: Tags + type: string + type: array tenant_id: - description: 'The 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 + type: boolean required: - site_id - tenant_id - ElementStatusV2N3: + ElementQueryFilterV2N5: properties: - analytics_backlog_connected: - description: 'The analytics backlog is connected. True or False. - - ' - type: boolean - analytics_backlog_connected_on_utc: - description: 'The analytics backlog is connected on utc. - - ' - format: int64 - type: integer - analytics_backlog_disconnected_on_utc: - description: "The analytics backlog is disconnected on utc. \n" - format: int64 - type: integer - analytics_backlog_from: - description: 'The IPv4 address of the analytics backlog. - - ' - type: string - analytics_live_connected: - description: "The live analytics is connected. True or False. \n" - type: boolean - analytics_live_connected_on_utc: - description: "The live analytics is connected on utc. \n" - format: int64 - type: integer - analytics_live_disconnected_on_utc: - description: 'The live analytics is disconnected on utc. - - ' - format: int64 - type: integer - analytics_live_from: - 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: "The config and events are connected. True or False. \n" - type: boolean - 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: "The config and events are disconnected on utc. \n" - format: int64 - type: integer - config_and_events_from: - 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: "The element ID. \n" - type: string - flows_backlog_connected: - description: "The flows backlog is connected. True or False. \n" - type: boolean - flows_backlog_connected_on_utc: - description: 'The flows backlog is connected on utc. - - ' - format: int64 - type: integer - flows_backlog_disconnected_on_utc: - description: "The flows backlog is disconnected on utc. \n" - format: int64 - type: integer - flows_backlog_from: - description: 'The IPv4 address of the flow backlog. - - ' - type: string - flows_live_connected: - description: "The live flows is connected. True or False. \n" - type: boolean - flows_live_connected_on_utc: - description: 'The live flows are connected on utc. - - ' - format: int64 - type: integer - flows_live_disconnected_on_utc: - description: "The live flows are disconnected on utc. \n" - format: int64 - type: integer - flows_live_from: - description: 'The IPV4 address of live flows. - - ' - type: string - 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: 'The backlog logs are connected. True or False. - - ' - type: boolean - logs_backlog_connected_on_utc: - description: "The backlog logs are connected on utc. \n" - format: int64 - type: integer - logs_backlog_disconnected_on_utc: - description: 'The backlog logs disconnected on utc. - - ' - format: int64 - type: integer - logs_backlog_from: - description: 'The IPV4 address for logs backlog. - - ' - type: string - logs_live_connected: - 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: 'The live logs are disconnected on utc. - - ' - format: int64 - type: integer - logs_live_from: - description: "The IPv4 address from the live logs. \n" - type: string - main_max_power_supported: - description: 'The main max power supported. - - ' - format: int32 - type: integer - main_power_allocated: - description: 'The main power allocated. - - ' - format: float - type: number - main_power_usage_threshold: - description: "The main power usage threshold. \n" - format: int32 - type: integer - poe_state: - description: 'The poe_state. - - ' - type: string - site_id: - description: "The site ID. \n" - type: string - switch_state: - $ref: '#/components/schemas/SwitchState' - description: 'The switch state. - - ' - tenant_id: - description: 'The tenant ID. - - ' - type: string - required: - - site_id - - tenant_id - ElementV3: - properties: - admin_action: - description: 'The values of admin actions that can be performed. - - ' - enum: - - ALLOCATE - - CLAIM - - BOUND - - UNBOUND - - DECLAIM - - RETURN - - REVOKE - - RETIRE - - STOCK - - UPGRADE - - REMANUFACTURE - - DEFAULT - - INVALID + admin_action: + description: Admin Action + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID type: string admin_renew_state: - description: 'The values of admin renew state. - - ' + description: Admin Renew State enum: - SLEEP - INIT @@ -2789,7 +2381,7 @@ components: - DECOMMISSION type: string admin_suspend_state: - description: "The values of the admin suspend state. \n" + description: Admin Suspend State enum: - SLEEP - INIT @@ -2862,7 +2454,7 @@ components: - DECOMMISSION type: string allowed_roles: - description: "The allowed roles. \n" + description: Allowed Roles items: description: Allowed Roles enum: @@ -2874,20 +2466,17 @@ components: - PA_CONN type: string type: array - cluster_id: - description: 'The spoke HA config cluster ID. - - ' + cluster_insertion_mode: + description: Cluster Insertion Mode + type: string + cluster_member_id: + description: Cluster Member Id type: string connected: - description: 'The element is connected. True or False. - - ' + description: Connected type: boolean deployment_op: - description: 'The deployment values. - - ' + description: Deployment Op enum: - DECLAIM - UPGRADE @@ -2907,97 +2496,55 @@ components: - GET_MAC_ADDRESS_TABLE type: string description: - description: 'The description of the element. - - ' - device_profile_id: - description: 'The device profile ID. - - ' + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string fips_mode: - description: 'The FIPs mode. - - ' + description: Fips Mode enum: - none - fips - non_fips type: string fips_mode_change_start_time: - description: 'The FIPs mode change starting time. - - ' + description: Fips Mode Change Start Time format: int64 type: integer hw_id: - description: 'The hardware ID. - - ' + description: Hw Id type: string id: description: Id type: string l3_direct_private_wan_forwarding: - description: 'The L3 direct private WAN is enabled. True or False. - - ' + description: L3 Direct Private Wan Forwarding type: boolean 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. - - ' + description: L3 Lan Forwarding type: boolean - led_config: - $ref: '#/components/schemas/LedConfig' - description: 'Valid LED config. - - ' - main_power_usage_threshold: - description: "The main power usage threshold. Allowed range is 50-100. \ - \ \n" - format: int32 - type: integer model_name: - description: "The model name of the device. \n" + description: Model Name type: string name: - description: 'The name of the device. - - ' + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string nat_policysetstack_id: - description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack - API. - - ' + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string network_policysetstack_id: - description: 'The ID for the Path Policyset Stack. Can be retrieved using - networkpolicysetstack API. - - ' + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - override_indicator: - description: 'The override indicator. - - ' - items: - description: Override Indicator - type: string - type: array priority_policysetstack_id: - description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack - API. - - ' + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string role: - description: 'The element role. - - ' + description: Role enum: - NONE - HUB @@ -3007,29 +2554,20 @@ components: - PA_CONN type: string serial_number: - description: 'The serial number. - - ' + description: Serial Number type: string site_id: - description: 'The site ID. - - ' + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' type: string software_version: - description: 'The software version. - - ' + description: Software Version type: string spoke_ha_config: $ref: '#/components/schemas/SpokeHAConfigV2' - description: 'The details of the spoke HA configuration. - - ' + description: 'Spoke Ha Config: Valid ' state: - description: 'The element state. - - ' + description: State enum: - ACTIVE_INIT - ACTIVE_INVENTORY_IN_PROGRESS @@ -3048,38 +2586,28 @@ components: - OOS - ACTIVE_DECLAIM_IN_PROGRESS type: string - switch_config: - $ref: '#/components/schemas/SwitchConfig' - description: 'The details of the switch configuration. - - ' tags: - description: 'A information field that can be added to identify the element. - - ' + 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) ' items: description: Tags type: string type: array tenant_id: - description: 'The 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: Vpn To Vpn Forwarding type: boolean required: - site_id - tenant_id - ElementV3N1: + ElementQueryFilterV2N6: properties: admin_action: - description: 'The values of admin actions that can be performed. - - ' + description: Admin Action enum: - ALLOCATE - CLAIM @@ -3096,9 +2624,7 @@ components: - INVALID type: string admin_renew_state: - description: 'The values of admin renew state. - - ' + description: Admin Renew State enum: - SLEEP - INIT @@ -3171,7 +2697,7 @@ components: - DECOMMISSION type: string admin_suspend_state: - description: "The values of the admin suspend state. \n" + description: Admin Suspend State enum: - SLEEP - INIT @@ -3244,7 +2770,7 @@ components: - DECOMMISSION type: string allowed_roles: - description: "The allowed roles. \n" + description: Allowed Roles items: description: Allowed Roles enum: @@ -3256,18 +2782,17 @@ components: - PA_CONN type: string type: array - cluster_id: - description: "The spoke HA config cluster ID. \n" + cluster_insertion_mode: + description: Cluster Insertion Mode + type: string + cluster_member_id: + description: Cluster Member Id type: string connected: - description: 'The element is connected. True or False. - - ' + description: Connected type: boolean deployment_op: - description: 'The deployment values. - - ' + description: Deployment Op enum: - DECLAIM - UPGRADE @@ -3287,123 +2812,70 @@ components: - GET_MAC_ADDRESS_TABLE type: string description: - 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 + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string device_profile_id: - description: 'The device profile ID. - - ' + description: Device Profile Id type: string fips_mode: - description: 'The FIPs mode. - - ' + description: Fips Mode enum: - none - fips - non_fips type: string fips_mode_change_start_time: - description: 'The FIPs mode change starting time. - - ' + description: Fips Mode Change Start Time format: int64 type: integer hw_id: - description: 'The hardware ID. - - ' + description: Hw Id type: string id: description: Id type: string l3_direct_private_wan_forwarding: - description: 'The L3 direct private WAN is enabled. True or False. - - ' + description: L3 Direct Private Wan Forwarding type: boolean 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. - - ' + description: L3 Lan Forwarding type: boolean - led_config: - $ref: '#/components/schemas/LedConfig' - description: 'Valid LED config. - - ' main_power_usage_threshold: - description: "The main power usage threshold. Allowed range is 50-100. \ - \ \n" + 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) ' format: int32 type: integer model_name: - description: "The model name of the device. \n" + description: Model Name type: string name: - description: 'The name of the device. - - ' + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string nat_policysetstack_id: - description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack - API. - - ' + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string network_policysetstack_id: - description: 'The ID for the Path Policyset Stack. Can be retrieved using - networkpolicysetstack API. - - ' + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string override_indicator: - description: 'The override indicator. - - ' + description: Override Indicator items: description: Override Indicator type: string type: array priority_policysetstack_id: - description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack - API. - - ' + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string role: - description: 'The element role. - - ' + description: Role enum: - NONE - HUB @@ -3413,29 +2885,20 @@ components: - PA_CONN type: string serial_number: - description: 'The serial number. - - ' + description: Serial Number type: string site_id: - description: 'The site ID. - - ' + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' type: string software_version: - description: 'The software version. - - ' + description: Software Version type: string spoke_ha_config: $ref: '#/components/schemas/SpokeHAConfigV2' - description: 'The details of the spoke HA configuration. - - ' + description: 'Spoke Ha Config: Valid ' state: - description: 'The element state. - - ' + description: State enum: - ACTIVE_INIT - ACTIVE_INVENTORY_IN_PROGRESS @@ -3456,5179 +2919,18843 @@ components: type: string switch_config: $ref: '#/components/schemas/SwitchConfig' - description: 'The details of the switch configuration. - - ' + description: 'Switch Config: Valid ' tags: - description: 'A information field that can be added to identify the element. - - ' + 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) ' items: description: Tags type: string type: array tenant_id: - description: 'The 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: Vpn To Vpn Forwarding type: boolean required: - site_id - tenant_id - Error: - properties: - _error: - items: - $ref: '#/components/schemas/ErrorResponse' - type: array - ErrorResponse: - properties: - code: - description: 'The error code. - - ' - type: string - message: - description: 'The error message. - - ' - type: string - Ethernet: + ElementQueryFilterV2N7: properties: - connector: - description: "The ethernet connector type. \n" - type: string - device: - description: "The device name. \n" - type: string - disabled: - description: 'Disable the port. - - ' - type: boolean - disabled_reason: - description: 'Reason to disable the port. - - ' - type: string - element_id: - description: 'Element ID. - - ' - type: string - id: - description: 'The connector ID. - - ' + admin_action: + description: Admin Action + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID type: string - inactive: - description: 'Port status (active or inactive). - - ' - type: boolean - inactive_reason: - description: 'Reason for port being inactive. - - ' + admin_renew_state: + description: Admin Renew State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - max_mtu: - description: 'The MTU max value. - - ' - type: integer - max_speed: - description: 'The max speed value. - - ' - type: integer - name: - description: 'The name. - - ' + admin_suspend_state: + description: Admin Suspend State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - original_mac_address: - description: 'The MAC address. - - ' + allowed_roles: + description: Allowed Roles + items: + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + type: array + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - region: - description: 'The region. - - ' + cluster_member_id: + description: Cluster Member Id type: string - site_id: - description: 'The site ID. - - ' + 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 - tenant_id: - description: 'The tenant ID. - - ' + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string - required: - - site_id - - tenant_id - EthernetPort: - properties: - full_duplex: - description: 'Interface running in full duplex mode. - - ' - type: boolean - port_id: - $ref: '#/components/schemas/Ethernet' - description: 'The ethernet port ID. - - ' - port_name: - description: 'The ethernet port name. - - ' + device_profile_id: + description: Device Profile Id type: string - speed: - description: "The ethernet port speed. \n" - format: int32 + fips_mode: + description: Fips Mode + enum: + - none + - fips + - non_fips + type: string + fips_mode_change_start_time: + description: Fips Mode Change Start Time + format: int64 type: integer - Extension: - properties: - conf: - type: object - disabled: - description: 'List the disabled extensions. - - ' - type: boolean - entity_id: - description: 'The entity ID. Only numbers are allowed (0-9). - - ' + hw_id: + description: Hw Id type: string id: - description: 'The ID. - - ' + description: Id + type: string + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + led_config: + $ref: '#/components/schemas/LedConfig' + description: 'Led Config: Valid ' + 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) ' + format: int32 + type: integer + model_name: + description: Model Name type: string name: - description: "The name of the extension. Max size = 128. \n" + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - namespace: - description: 'The extension namespace. Values = ^[a-z][a-z0-9/]*[a-z0-9]+$. - - ' + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string - tenant_id: - description: "The tenant ID. \n" + network_policysetstack_id: + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - required: - - conf - - namespace - - name - - tenant_id - ExtensionQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of element level extensions that match - the query parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number element level extensions deleted for a time frame. - - ' - type: boolean - group_by: - description: 'Group the element level extensions for the query. - - ' + override_indicator: + description: Override Indicator items: - description: Group By + description: Override Indicator type: string type: array - id: - description: "List the element level extensions by ID. \n" + priority_policysetstack_id: + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack 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: - 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. \n" - format: int64 - type: integer - ExtensionQueryFilter: - properties: - conf: - type: object - disabled: - description: 'List the disabled extensions. - - ' - type: boolean - id: - description: 'The ID. - - ' - type: string - name: - 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]+$. - - ' - type: string - tenant_id: - description: "The tenant ID. \n" - type: string - required: - - conf - - namespace - - name - - tenant_id - ExtensionScreen: - properties: - conf: - type: object - disabled: - description: 'List the disabled extensions. - - ' - type: boolean - entity_id: - description: 'The entity ID. Only numbers are allowed (0-9). - - ' - type: string - id: - description: 'The ID. - - ' + role: + description: Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - name: - description: "The name of the extension. Max size = 128. \n" + serial_number: + description: Serial Number type: string - namespace: - description: 'The extension namespace. Values = ^[a-z][a-z0-9/]*[a-z0-9]+$. - - ' + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' type: string - required: - - conf - - namespace - - name - GREConfig: - properties: - 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. - - ' - 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 - keepalive_local_ipv4: - description: 'The keepalive local ipv4 address. - - ' + software_version: + description: Software Version type: string - keepalive_remote_ipv4: - description: 'The keepalive remote ipv4 address. - - ' + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + 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 - HardwareBypass: - properties: - element_bypass: - description: "The information on the element bypass pair. \n" + switch_config: + $ref: '#/components/schemas/SwitchConfig' + description: 'Switch Config: Valid ' + 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) ' items: - $ref: '#/components/schemas/BypassInfo' + description: Tags + type: string type: array - id: - description: 'The ID. - - ' - type: string - IKEV1Params: - properties: - xauth_id: - description: 'The xauth ID. - - ' - type: string - xauth_secret: - description: 'The authentication secret. Length must be between 4-128. - - ' - type: string - xauth_secret_encrypted: - description: "The xauth secret. Value = True. \n" - type: string - xauth_secret_hash: - description: 'The xauth hash. Value = True. - - ' - type: string - xauth_type: - description: 'The xauth type. - - ' - enum: - - NONE - - SECRET + 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 + type: boolean required: - - xauth_type - IPSECAuthentication: + - site_id + - tenant_id + ElementQueryFilterV3: properties: - certificate: - description: 'The certificate authentication for the IPsec Profile. + admin_action: + description: 'The values of admin actions that can be performed. ' + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID 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 ' - local_ca_certificate: - description: "The local CA certificate uploaded for certificate authentication.\ - \ \n" - type: string - local_id: - description: 'The local ID type. + admin_renew_state: + description: 'The values of admin renew state. ' enum: - - LOCAL_IP - - 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) ' + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - peer_id_check: - description: Peer Id Check + admin_suspend_state: + description: "The values of the admin suspend state. \n" enum: - - EXACT - - WILDCARD + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - permit_peer_id_mismatch: - description: Permit Peer Id Mismatch - type: boolean - private_key: - description: 'The private key file uploaded for certificate authentication. + 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_id: + description: "The spoke HA config cluster ID. \n" + type: string + connected: + description: 'The element is connected. True or False. ' - type: string - private_key_encrypted: - description: 'Private Key Encrypted: JsonIgnore(value = true) ' - type: string - remote_ca_certificate: - description: "The standard VPN endpoint CA certificate uploaded. \ - \ \n" - type: string - remote_id: - description: "The ID for the standard VPN endpoint in the Remote ID field.\ - \ \n" - type: string - secret: - description: "The password for PSK authentication. \n" - type: string - secret_encrypted: - description: 'Secret Encrypted: JsonIgnore(value = true) ' - type: string - 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. + deployment_op: + description: 'The deployment values. ' enum: - - NONE - - PSK - - X509 + - 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 - x509Objects: - $ref: '#/components/schemas/X509Objects' - description: 'X509Objects: JsonIgnore(value = true) ' - required: - - local_id - - type - IPSECConfig: - properties: - authentication: - $ref: '#/components/schemas/IPSECAuthentication' - description: 'The IPSec authentication details. + description: + description: 'The description of the element. ' - ipsec_profile_id: - description: 'The IPSec profile ID. + device_profile_id: + description: 'The device profile ID. ' type: string - required: - - ipsec_profile_id - IPv4Range: - properties: - end: - description: 'The end IPv4 address. + fips_mode: + description: 'The FIPs mode. ' + enum: + - none + - fips + - non_fips type: string - start: - description: "The start IPv4 address. \n" - type: string - required: - - end - - start - IPv6DNS: - properties: - name_servers: - description: 'The IPv6 configured DNS name servers. + fips_mode_change_start_time: + description: 'The FIPs mode change starting time. ' - items: - description: Name Servers - type: string - type: array - search: - description: 'The search parameters. + format: int64 + type: integer + hw_id: + description: 'The hardware ID. ' - items: - description: Search - type: string - type: array - InterfaceScreenV4N16: - properties: - admin_up: - description: 'The interface admin state. + type: string + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: 'The L3 direct private WAN is enabled. True or False. ' type: boolean - attached_lan_networks: - description: 'The attached lan network ID and vlan ID. + 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. ' - items: - $ref: '#/components/schemas/LanNetworkVlanMapping' - type: array - authentication_config: - $ref: '#/components/schemas/AuthenticationInterfaceConfig' - description: 'The authentication config details. + type: boolean + led_config: + $ref: '#/components/schemas/LedConfig' + description: 'Valid LED config. ' - bound_interfaces: - description: 'The bound interfaces. + main_power_usage_threshold: + description: "The main power usage threshold. Allowed range is 50-100. \ + \ \n" + format: int32 + type: integer + model_name: + description: "The model name of the device. \n" + type: string + name: + description: 'The name of the device. ' - items: - description: Bound Interfaces - type: string - type: array - bypass_pair: - $ref: '#/components/schemas/BypassPairV2' - description: 'The details of the bypass pair. + type: string + nat_policysetstack_id: + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. ' - cellular_config: - $ref: '#/components/schemas/CellularInterfaceConfig' - description: 'The cellular config details. + type: string + network_policysetstack_id: + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. ' - description: - description: 'The interface description. Max size = 256. + type: string + override_indicator: + description: 'The override indicator. ' - devicemgmt_policysetstack_id: - description: 'The device management policy set stack ID. + items: + description: Override Indicator + type: string + type: array + priority_policysetstack_id: + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. ' type: string - dhcp_relay: - $ref: '#/components/schemas/DHCPRelay' - description: 'The DHCP relay information. - - ' - directed_broadcast: - description: 'The directed broadcast. + role: + description: 'The element role. ' - type: boolean - ethernet_port: - $ref: '#/components/schemas/EthernetPort' - description: 'The ethernet port information. + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + serial_number: + description: 'The serial number. ' - id: - description: 'The interface ID. + type: string + site_id: + description: 'The site ID. ' type: string - interface_profile_id: - description: 'The interface profile ID. + software_version: + description: 'The software version. ' type: string - ipfixcollectorcontext_id: - description: 'The IPFIX collector context ID. + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'The details of the spoke HA configuration. ' - type: string - ipfixfiltercontext_id: - description: 'The IPFIX filter context ID. + 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 - ipv4_config: - $ref: '#/components/schemas/Ipv4Config' - description: 'The ipv4 config information. + switch_config: + $ref: '#/components/schemas/SwitchConfig' + description: 'The details of the switch configuration. ' - ipv6_config: - $ref: '#/components/schemas/Ipv6ConfigV1' - description: 'The ipv6 config information. + tags: + description: 'A information field that can be added to identify the element. ' - lldp_enabled: - description: 'If LLDP enabled. True/False. + items: + description: Tags + type: string + type: array + tenant_id: + description: 'The tenant ID. ' - type: boolean - mac_address: - description: 'The interface configuration MAC address. + type: string + vpn_to_vpn_forwarding: + description: 'VPN to VPN forwarding. True or False. ' + type: boolean + required: + - site_id + - tenant_id + ElementScreen: + properties: + cluster_insertion_mode: + description: "The cluster insertion mode. \n" type: string - mtu: - description: 'The MTU value of the interface. + cluster_member_id: + description: 'The cluster member ID. ' - type: integer - multicast_config: - $ref: '#/components/schemas/MulticastInterfaceConfig' - description: 'The multicast config details. + type: string + description: + description: 'The description of the element. ' + id: + description: Id + type: string name: - description: 'The name of the interface state. Max size = 128. + description: 'The name of the element. ' type: string - nat_address: - description: 'The NAT IP address. + site_id: + description: 'The site ID. ' type: string - nat_address_v6: - description: 'The NAT IPV6 address. + sw_obj: + $ref: '#/components/schemas/Software' + description: 'The location and version of the software. ' + required: + - site_id + ElementScreenV2N1: + properties: + cluster_insertion_mode: + description: "The cluster insertion mode. \n" type: string - nat_pools: - description: 'The NAT pools information. + cluster_member_id: + description: 'The cluster member ID. ' - items: - $ref: '#/components/schemas/NatPool' - type: array - nat_port: - description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part - of logical interface groups. + type: string + description: + description: 'The description of the element. ' - format: int32 - type: integer - nat_port_v6: - description: "The NAT IPv6 port.Internet bypass ports cannot be part of\ - \ logical interface groups. \n" - format: int32 - type: integer - nat_zone_id: - description: 'The NAT zone ID. + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: 'The L3 direct private WAN is enabled. True or False. ' - type: string - network_context_id: - description: 'The network context ID. + type: boolean + 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 + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - parent: - description: 'The parent value = true. + network_policysetstack_id: + description: 'The network policy stack ID. ' type: string - peer_bypasspair_wan_port_type: - description: 'The peer bypass pair WAN port type. + priority_policysetstack_id: + description: 'The priority policy set stack ID. ' - enum: - - none - - cellular type: string - poe_enabled: - description: 'PoE enabled = true/false. + site_id: + description: 'The site ID. ' - type: boolean - power_usage_threshold: - description: 'The interface config PoE power usage threshold. Valid values - are in the range 50-100. + type: string + sw_obj: + $ref: '#/components/schemas/Software' + description: 'The location and version of the software object. ' - format: int32 - type: integer - pppoe_config: - $ref: '#/components/schemas/PppoEInterfaceConfig' - description: 'The PPPoE config information. - - ' - scope: - description: 'The network scope. - - ' - enum: - - GLOBAL - - LOCAL + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' type: string - secondary_ip_configs: - description: 'The interface secondary IP config. Secondary IPs exceed the - supported limit of 8. - - ' - items: - $ref: '#/components/schemas/SecondaryIPConfig' - type: array - service_link_config: - $ref: '#/components/schemas/ServiceLinkV2' - description: 'The interface secondary IP config. Secondary IPs exceed the - supported limit of 8. - - ' - site_wan_interface_ids: - description: 'The site WAN interface IDs. - - ' - items: - description: Site Wan Interface Ids - type: string - type: array - static_arp_configs: - description: 'The static ARP config details. - - ' - items: - $ref: '#/components/schemas/StaticARPConfig' - type: array - sub_interface: - $ref: '#/components/schemas/SubInterface' - description: 'The sub interface vlan ID. - - ' - switch_port_config: - $ref: '#/components/schemas/SwitchPortConfig' - description: 'The switch port config details. - - ' + required: + - site_id + - tenant_id + ElementScreenV2N2: + properties: + cluster_insertion_mode: + description: Cluster Insertion Mode + type: string + cluster_member_id: + description: Cluster Member Id + type: string + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + 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) ' + 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) ' + type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV1' + description: 'Spoke Ha Config: Valid ' + sw_obj: + $ref: '#/components/schemas/Software' + description: Sw Obj tags: - description: 'A information field that can be added to identify the interface. - Maximum 10 Unique tags of length 1024 each are allowed. - - ' + 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) ' items: description: Tags type: string type: array - type: - description: 'The interface type. - - ' - type: string - used_for: - description: 'The interface used for value. The allowed values are public,private_wan,lan,none. - - ' - type: string - vlan_config: - $ref: '#/components/schemas/VlanConfig' - description: 'The VLAN config details. - - ' - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. - - ' + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' type: string required: - - peer_bypasspair_wan_port_type - - scope - - used_for - - type - InterfaceScreenV4N17: + - site_id + - tenant_id + ElementScreenV2N3: properties: - admin_up: - description: 'The interface admin state. - - ' + cluster_insertion_mode: + description: Cluster Insertion Mode + type: string + cluster_member_id: + description: Cluster Member Id + type: string + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding type: boolean - attached_lan_networks: - description: 'The attached lan network ID and vlan ID. - - ' - items: - $ref: '#/components/schemas/LanNetworkVlanMapping' - type: array - authentication_config: - $ref: '#/components/schemas/AuthenticationInterfaceConfig' - description: 'The authentication config details. - - ' - bound_interfaces: - description: 'The bound interfaces. - - ' + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + 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.) ' + 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) ' + 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) ' + type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV1' + description: 'Spoke Ha Config: Valid ' + sw_obj: + $ref: '#/components/schemas/Software' + description: Sw Obj + 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) ' items: - description: Bound Interfaces + description: Tags type: string type: array - bypass_pair: - $ref: '#/components/schemas/BypassPairV2' - description: 'The details of the bypass pair. - - ' - cellular_config: - $ref: '#/components/schemas/CellularInterfaceConfig' - description: 'The cellular config details. - - ' - description: - description: 'The interface description. Max size = 256. - - ' - devicemgmt_policysetstack_id: - description: 'The device management policy set stack ID. - - ' + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' type: string - dhcp_relay: - $ref: '#/components/schemas/DHCPRelay' - description: 'The DHCP relay information. - - ' - directed_broadcast: - description: 'The directed broadcast. - - ' + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding type: boolean - ethernet_port: - $ref: '#/components/schemas/EthernetPort' - description: 'The ethernet port information. - - ' - id: - description: 'The interface ID. - - ' + required: + - site_id + - tenant_id + ElementScreenV2N4: + properties: + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - interface_profile_id: - description: 'The interface profile ID. - - ' + cluster_member_id: + description: Cluster Member Id type: string - ipfixcollectorcontext_id: - description: 'The IPFIX collector context ID. - - ' + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string - ipfixfiltercontext_id: - description: 'The IPFIX filter context ID. - - ' + id: + description: Id type: string - ipv4_config: - $ref: '#/components/schemas/Ipv4Config' - description: 'The ipv4 config information. - - ' - ipv6_config: - $ref: '#/components/schemas/Ipv6ConfigV1' - description: 'The ipv6 config information. - - ' - lldp_enabled: - description: 'If LLDP enabled. True/False. - - ' + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding type: boolean - mac_address: - description: 'The interface configuration MAC address. - - ' - type: string - mtu: - description: 'The MTU value of the interface. - - ' - type: integer - multicast_config: - $ref: '#/components/schemas/MulticastInterfaceConfig' - description: 'The multicast config details. - - ' name: - description: 'The name of the interface state. Max size = 128. - - ' + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - nat_address: - description: 'The NAT IP address. - - ' + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string - nat_address_v6: - description: 'The NAT IPV6 address. - - ' + network_policysetstack_id: + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - nat_pools: - description: 'The NAT pools information. - - ' + priority_policysetstack_id: + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' + type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + sw_obj: + $ref: '#/components/schemas/Software' + description: Sw Obj + 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) ' items: - $ref: '#/components/schemas/NatPool' + description: Tags + type: string type: array - nat_port: - description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part - of logical interface groups. - - ' + 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 + type: boolean + required: + - site_id + - tenant_id + ElementScreenV2N5: + properties: + cluster_insertion_mode: + description: Cluster Insertion Mode + type: string + cluster_member_id: + description: Cluster Member Id + type: string + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + 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.) ' + 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) ' + 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) ' + type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + sw_obj: + $ref: '#/components/schemas/Software' + description: Sw Obj + 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) ' + items: + description: Tags + 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 + type: boolean + required: + - site_id + - tenant_id + ElementScreenV2N6: + properties: + cluster_insertion_mode: + description: Cluster Insertion Mode + type: string + cluster_member_id: + description: Cluster Member Id + type: string + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + device_profile_id: + description: Device Profile Id + type: string + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + 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) ' format: int32 type: integer - nat_port_v6: - description: "The NAT IPv6 port.Internet bypass ports cannot be part of\ - \ logical interface groups. \n" + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + 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.) ' + 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) ' + 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) ' + type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + sw_obj: + $ref: '#/components/schemas/Software' + description: Sw Obj + switch_config: + $ref: '#/components/schemas/SwitchConfig' + description: 'Switch Config: Valid ' + 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) ' + items: + description: Tags + 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 + type: boolean + required: + - site_id + - tenant_id + ElementScreenV2N7: + properties: + cluster_insertion_mode: + description: Cluster Insertion Mode + type: string + cluster_member_id: + description: Cluster Member Id + type: string + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + device_profile_id: + description: Device Profile Id + type: string + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + led_config: + $ref: '#/components/schemas/LedConfig' + description: 'Led Config: Valid ' + 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) ' format: int32 type: integer - nat_zone_id: - description: 'The NAT zone ID. - - ' + 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 network context ID. - - ' + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string - parent: - description: 'The parent value = true. + network_policysetstack_id: + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' + 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) ' + type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + sw_obj: + $ref: '#/components/schemas/Software' + description: Sw Obj + switch_config: + $ref: '#/components/schemas/SwitchConfig' + description: 'Switch Config: Valid ' + 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) ' + items: + description: Tags + 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 + type: boolean + required: + - site_id + - tenant_id + ElementScreenV3: + properties: + cluster_id: + description: "The cluster ID. \n" + type: string + description: + description: 'The description of the element. ' + device_profile_id: + description: "The device profile ID. \n" + type: string + id: + description: "The element ID. \n" type: string - peer_bypasspair_wan_port_type: - description: 'The peer bypass pair WAN port type. + l3_direct_private_wan_forwarding: + description: 'The L3 direct private WAN is enabled. True or False. ' - enum: - - none - - cellular - type: string - poe_enabled: - description: 'PoE enabled = true/false. + type: boolean + 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 - power_usage_threshold: - description: 'The interface config PoE power usage threshold. Valid values - are in the range 50-100. + led_config: + $ref: '#/components/schemas/LedConfig' + description: 'Valid LED config. ' + main_power_usage_threshold: + description: "The main power usage threshold. Allowed range is 50-100. \ + \ \n" format: int32 type: integer - pppoe_config: - $ref: '#/components/schemas/PppoEInterfaceConfig' - description: 'The PPPoE config information. + name: + description: 'The name of the device. ' - scope: - description: 'The network scope. + type: string + nat_policysetstack_id: + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. ' - enum: - - GLOBAL - - LOCAL type: string - secondary_ip_configs: - description: 'The interface secondary IP config. Secondary IPs exceed the - supported limit of 8. + network_policysetstack_id: + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. ' - items: - $ref: '#/components/schemas/SecondaryIPConfig' - type: array - service_link_config: - $ref: '#/components/schemas/ServiceLinkV2' - description: 'The interface secondary IP config. Secondary IPs exceed the - supported limit of 8. + type: string + priority_policysetstack_id: + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. ' - site_wan_interface_ids: - description: 'The site WAN interface IDs. + type: string + site_id: + description: "The site ID. \n" + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'The details of the spoke HA configuration. ' - items: - description: Site Wan Interface Ids - type: string - type: array - static_arp_configs: - description: 'The static ARP config details. + sw_obj: + $ref: '#/components/schemas/Software' + description: 'The location and version of the software. ' - items: - $ref: '#/components/schemas/StaticARPConfig' - type: array - sub_interface: - $ref: '#/components/schemas/SubInterface' - description: 'The sub interface vlan ID. - - ' - switch_port_config: - $ref: '#/components/schemas/SwitchPortConfig' - description: 'The switch port config details. + switch_config: + $ref: '#/components/schemas/SwitchConfig' + description: 'The details of the switch configuration. ' tags: - description: 'A information field that can be added to identify the interface. - Maximum 10 Unique tags of length 1024 each are allowed. + description: 'A information field that can be added to identify the element. ' items: description: Tags type: string type: array - type: - description: 'The interface type. + 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. + + ' + type: boolean + required: + - site_id + - tenant_id + ElementSoftwareState: + properties: + download_interval: + description: 'The software download interval. Valid download interval must + be provided along with a valid download time. + + ' + type: integer + id: + description: 'The ID. ' type: string - used_for: - description: 'The interface used for value. The allowed values are public,private_wan,lan,none. + image_id: + description: 'The element image ID. ' type: string - vlan_config: - $ref: '#/components/schemas/VlanConfig' - description: 'The VLAN config details. + interface_ids: + description: 'The software interface IDs. + + ' + items: + description: Interface Ids + type: string + type: array + scheduled_download: + description: 'The scheduled download. ' - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. + type: string + scheduled_upgrade: + description: 'The scheduled upgrade. ' type: string - required: - - peer_bypasspair_wan_port_type - - scope - - used_for - - type - InterfaceStateV3N5: + upgrade_interval: + description: 'The upgrade interval of the firmware. Valid upgrade interval + must be provided along with a valid upgrade time. + + ' + type: integer + ElementSoftwareStateScreen: properties: - cellular_state: - $ref: '#/components/schemas/CellularState' - description: 'The cellular state details. + download_interval: + description: 'The software download interval. Valid download interval must + be provided along with a valid download time. ' - device: - description: 'The ION device. + type: integer + id: + description: 'The ID. ' type: string - dns_v4_config: - $ref: '#/components/schemas/DNS' - description: 'The DNS v4 config details. + image_id: + description: 'The element image ID. ' - dns_v6_config: - $ref: '#/components/schemas/IPv6DNS' - description: 'The DNS v6 config details. + type: string + interface_ids: + description: 'The software interface IDs. ' - effective_vlans: - description: Effective Vlans items: - description: Effective Vlans - type: integer + description: Interface Ids + type: string type: array - element_id: - description: 'The element ID. + scheduled_download: + description: 'The scheduled download. ' type: string - extended_state: - description: 'The extended state. + scheduled_upgrade: + description: 'The scheduled upgrade. ' type: string + upgrade_interval: + description: 'The upgrade interval of the firmware. Valid upgrade interval + must be provided along with a valid upgrade time. + + ' + type: integer + ElementState: + properties: id: - description: 'The interface ID. + description: 'The ID. ' type: string - ipv4_addresses: - description: "The IPv4 addresses configured for the interface. \n" - items: - description: Ipv4 Addresses - type: string - type: array - ipv6_addresses: - description: "The IPv6 addresses configured for the interface. \n" - items: - description: Ipv6 Addresses - type: string - type: array - last_state_change: - description: 'The last state change of the device. + image_id: + description: 'The element image ID. ' - format: int64 - type: integer - 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. + scheduled_upgrade: + description: 'The scheduled upgrade. ' type: string - name: - description: 'The name of the interface state. Max size = 128. + ElementStateQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of element states that match the query + parameters. ' - type: string - negotiated_mtu: - description: 'The negotiated IP MTU value. + dest_page: + description: 'The destination page. ' format: int32 type: integer - operational_state: - description: 'The operational state. + getDeleted: + description: 'The number element states deleted for a time frame. ' + type: boolean + group_by: + description: 'Group the element states for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the element state by ID. \n" type: string - poe_state: - $ref: '#/components/schemas/PoeStateS' - description: Poe State - port: - $ref: '#/components/schemas/Port' - description: 'The start and end port details. + last_query_ts: + description: 'Return the ID of a specified query in the current session. ' - remote_host_name: - description: 'The remote host name. + format: int64 + type: integer + limit: + description: 'The query limit. ' - type: string - remote_v4_addr: - description: 'The remote IPv4 address. + format: int32 + type: integer + next_query: + description: 'The limit. ' - type: string - routes: - description: "The routing details. \n" - items: - $ref: '#/components/schemas/Route' - type: array - routes_v6: - description: 'The route v6 details. + type: object + query_params: + description: 'Query using query parameters. ' - items: - $ref: '#/components/schemas/Ipv6Route' - type: array - secondary_ipv4_addresses: - description: 'The secondary IPv4 addresses. + type: object + retrieved_fields: + description: 'Retrieve information from a field. ' items: - description: Secondary Ipv4 Addresses + description: Retrieved Fields type: string type: array - service_link: - $ref: '#/components/schemas/ServiceLink' - description: 'The service link details ServiceLink. + retrieved_fields_mask: + description: 'List the fields to query. ' - stp_state: - $ref: '#/components/schemas/STPStateS' - description: 'The STP state details. + type: boolean + sort_params: + description: 'Specify the order in which you want the search criteria to + display. ' - svi_state: - $ref: '#/components/schemas/SVIStateS' - description: 'The svi details. + type: object + total_count: + description: 'The total number of query parameters. ' - InterfaceStateV3N6: + format: int64 + type: integer + ElementStateQueryFilter: properties: - cellular_state: - $ref: '#/components/schemas/CellularState' - description: 'The cellular state details. + id: + description: 'The ID. ' - device: - description: 'The ION device. + type: string + image_id: + description: 'The element image ID. ' type: string - dns_v4_config: - $ref: '#/components/schemas/DNS' - description: 'The DNS v4 config details. + scheduled_download: + description: 'The scheduled download. ' - dns_v6_config: - $ref: '#/components/schemas/IPv6DNS' - 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. + type: string + scheduled_upgrade: + description: 'The scheduled upgrade. ' type: string - extended_state: - description: 'The extended state. + ElementStateScreen: + properties: + id: + description: 'The ID. ' type: string - id: - description: 'The interface ID. + image_id: + description: 'The element image ID. ' type: string - ipv4_addresses: - description: "The IPv4 addresses configured for the interface. \n" - items: - description: Ipv4 Addresses - type: string - type: array - ipv6_addresses: - description: "The IPv6 addresses configured for the interface. \n" - items: - description: Ipv6 Addresses - type: string - type: array - last_state_change: - description: 'The last state change of the device. + scheduled_upgrade: + description: 'The scheduled upgrade. ' + type: string + ElementStatus: + properties: + analytics_backlog_connected: + description: Analytics Backlog Connected + type: boolean + analytics_backlog_connected_on_utc: + description: Analytics Backlog Connected On Utc format: int64 type: integer - link_local_address: - description: "The link local address. \n" + analytics_backlog_disconnected_on_utc: + description: Analytics Backlog Disconnected On Utc + format: int64 + type: integer + analytics_backlog_from: + description: Analytics Backlog From type: string - lldp_enabled: - description: Lldp Enabled + analytics_live_connected: + description: Analytics Live Connected type: boolean - mac_address: - description: 'The interface configuration MAC address. - - ' + analytics_live_connected_on_utc: + description: Analytics Live Connected On Utc + format: int64 + type: integer + analytics_live_disconnected_on_utc: + description: Analytics Live Disconnected On Utc + format: int64 + type: integer + analytics_live_from: + description: Analytics Live From type: string - name: - description: 'The name of the interface state. Max size = 128. - - ' + config_and_events_connected: + description: Config And Events Connected + type: boolean + config_and_events_connected_on_utc: + description: Config And Events Connected On Utc + format: int64 + type: integer + config_and_events_disconnected_on_utc: + description: Config And Events Disconnected On Utc + format: int64 + type: integer + config_and_events_from: + description: Config And Events From type: string - negotiated_mtu: - description: 'The negotiated IP MTU value. - - ' - format: int32 + element_id: + description: Element Id + type: string + flows_backlog_connected: + description: Flows Backlog Connected + type: boolean + flows_backlog_connected_on_utc: + description: Flows Backlog Connected On Utc + format: int64 type: integer - operational_state: - description: 'The operational state. - - ' + flows_backlog_disconnected_on_utc: + description: Flows Backlog Disconnected On Utc + format: int64 + type: integer + flows_backlog_from: + description: Flows Backlog From type: string - poe_state: - $ref: '#/components/schemas/PoeStateS' - description: Poe State - port: - $ref: '#/components/schemas/Port' - description: 'The start and end port details. - - ' - remote_host_name: - description: 'The remote host name. + flows_live_connected: + description: Flows Live Connected + type: boolean + flows_live_connected_on_utc: + description: Flows Live Connected On Utc + format: int64 + type: integer + flows_live_disconnected_on_utc: + description: Flows Live Disconnected On Utc + format: int64 + type: integer + flows_live_from: + description: Flows Live From + type: string + id: + description: Id + type: string + logs_backlog_connected: + description: Logs Backlog Connected + type: boolean + logs_backlog_connected_on_utc: + description: Logs Backlog Connected On Utc + format: int64 + type: integer + logs_backlog_disconnected_on_utc: + description: Logs Backlog Disconnected On Utc + format: int64 + type: integer + logs_backlog_from: + description: Logs Backlog From + type: string + logs_live_connected: + description: Logs Live Connected + type: boolean + logs_live_connected_on_utc: + description: Logs Live Connected On Utc + format: int64 + type: integer + logs_live_disconnected_on_utc: + description: Logs Live Disconnected On Utc + format: int64 + type: integer + logs_live_from: + description: Logs Live From + type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + type: string + required: + - site_id + - tenant_id + ElementStatusQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of element status that match the query + parameters. ' - type: string - remote_v4_addr: - description: 'The remote IPv4 address. + dest_page: + description: 'The destination page. ' - type: string - routes: - description: "The routing details. \n" - items: - $ref: '#/components/schemas/Route' - type: array - routes_v6: - description: 'The route v6 details. + format: int32 + type: integer + getDeleted: + description: 'The number element status deleted for a time frame. ' - items: - $ref: '#/components/schemas/Ipv6Route' - type: array - secondary_ipv4_addresses: - description: 'The secondary IPv4 addresses. + type: boolean + group_by: + description: 'Group the element status for the query. ' items: - description: Secondary Ipv4 Addresses + description: Group By type: string type: array - service_link: - $ref: '#/components/schemas/ServiceLink' - description: 'The service link details ServiceLink. - - ' - stp_state: - $ref: '#/components/schemas/STPStateS' - description: 'The STP state details. - - ' - svi_state: - $ref: '#/components/schemas/SVIStateS' - description: 'The svi details. + id: + description: "List the element status by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. ' - vrf: - $ref: '#/components/schemas/VRF' - description: "The VRF details. \n" - InterfaceV4N16: - properties: - admin_up: - description: 'The interface admin state. + format: int64 + type: integer + limit: + description: 'The query limit. ' - type: boolean - attached_lan_networks: - description: 'The attached lan network ID and vlan ID. + format: int32 + type: integer + next_query: + description: 'The limit. ' - items: - $ref: '#/components/schemas/LanNetworkVlanMapping' - type: array - authentication_config: - $ref: '#/components/schemas/AuthenticationInterfaceConfig' - description: 'The authentication config details. + type: object + query_params: + description: 'Query using query parameters. ' - bound_interfaces: - description: 'The bound interfaces. + type: object + retrieved_fields: + description: 'Retrieve information from a field. ' items: - description: Bound Interfaces + description: Retrieved Fields type: string type: array - bypass_pair: - $ref: '#/components/schemas/BypassPairV2' - description: 'The details of the bypass pair. - - ' - cellular_config: - $ref: '#/components/schemas/CellularInterfaceConfig' - description: 'The cellular config details. + retrieved_fields_mask: + description: 'List the fields to query. ' - description: - description: 'The interface description. Max size = 256. + type: boolean + sort_params: + description: 'Specify the order in which you want the search criteria to + display. ' - devicemgmt_policysetstack_id: - description: 'The device management policy set stack ID. + type: object + total_count: + description: 'The total number of query parameters. ' + format: int64 + type: integer + ElementStatusV2N1: + properties: + analytics_backlog_connected: + description: Analytics Backlog Connected + type: boolean + analytics_backlog_connected_on_utc: + description: Analytics Backlog Connected On Utc + format: int64 + type: integer + analytics_backlog_disconnected_on_utc: + description: Analytics Backlog Disconnected On Utc + format: int64 + type: integer + analytics_backlog_from: + description: Analytics Backlog From type: string - dhcp_relay: - $ref: '#/components/schemas/DHCPRelay' - description: 'The DHCP relay information. - - ' - directed_broadcast: - description: 'The directed broadcast. - - ' + analytics_live_connected: + description: Analytics Live Connected type: boolean - ethernet_port: - $ref: '#/components/schemas/EthernetPort' - description: 'The ethernet port information. - - ' + analytics_live_connected_on_utc: + description: Analytics Live Connected On Utc + format: int64 + type: integer + analytics_live_disconnected_on_utc: + description: Analytics Live Disconnected On Utc + format: int64 + type: integer + analytics_live_from: + description: Analytics Live From + type: string + config_and_events_connected: + description: Config And Events Connected + type: boolean + config_and_events_connected_on_utc: + description: Config And Events Connected On Utc + format: int64 + type: integer + config_and_events_disconnected_on_utc: + description: Config And Events Disconnected On Utc + format: int64 + type: integer + config_and_events_from: + description: Config And Events From + type: string + element_id: + description: Element Id + type: string + flows_backlog_connected: + description: Flows Backlog Connected + type: boolean + flows_backlog_connected_on_utc: + description: Flows Backlog Connected On Utc + format: int64 + type: integer + flows_backlog_disconnected_on_utc: + description: Flows Backlog Disconnected On Utc + format: int64 + type: integer + flows_backlog_from: + description: Flows Backlog From + type: string + flows_live_connected: + description: Flows Live Connected + type: boolean + flows_live_connected_on_utc: + description: Flows Live Connected On Utc + format: int64 + type: integer + flows_live_disconnected_on_utc: + description: Flows Live Disconnected On Utc + format: int64 + type: integer + flows_live_from: + description: Flows Live From + type: string id: - description: 'The interface ID. - - ' + description: Id type: string - interface_profile_id: - description: 'The interface profile ID. - - ' + logs_backlog_connected: + description: Logs Backlog Connected + type: boolean + logs_backlog_connected_on_utc: + description: Logs Backlog Connected On Utc + format: int64 + type: integer + logs_backlog_disconnected_on_utc: + description: Logs Backlog Disconnected On Utc + format: int64 + type: integer + logs_backlog_from: + description: Logs Backlog From type: string - ipfixcollectorcontext_id: - description: 'The IPFIX collector context ID. - - ' + logs_live_connected: + description: Logs Live Connected + type: boolean + logs_live_connected_on_utc: + description: Logs Live Connected On Utc + format: int64 + type: integer + logs_live_disconnected_on_utc: + description: Logs Live Disconnected On Utc + format: int64 + type: integer + logs_live_from: + description: Logs Live From type: string - ipfixfiltercontext_id: - description: 'The IPFIX filter context ID. - - ' + main_max_power_supported: + description: Main Max Power Supported + format: int32 + type: integer + main_power_allocated: + description: 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) ' + format: int32 + type: integer + poe_state: + description: Poe State type: string - ipv4_config: - $ref: '#/components/schemas/Ipv4Config' - description: 'The ipv4 config information. - - ' - ipv6_config: - $ref: '#/components/schemas/Ipv6ConfigV1' - description: 'The ipv6 config information. + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + switch_state: + $ref: '#/components/schemas/SwitchState' + description: Switch State + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + type: string + required: + - site_id + - tenant_id + ElementV2N1: + 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. ' - lldp_enabled: - description: 'If LLDP enabled. True/False. + type: string + connected: + description: 'The device is connected. True or False. ' type: boolean - mac_address: - description: 'The interface configuration MAC address. + 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 - mtu: - description: 'The MTU value of the interface. + description: + description: 'The description of the element. ' - type: integer - multicast_config: - $ref: '#/components/schemas/MulticastInterfaceConfig' - description: 'The multicast config details. + hw_id: + description: "The hardware ID. \n" + type: string + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: 'The L3 direct private WAN is enabled. True or False. ' - name: - description: 'The name of the interface state. Max size = 128. + type: boolean + 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 + model_name: + description: "The model name of the device. \n" type: string - nat_address: - description: 'The NAT IP address. + name: + description: 'The name of the device. ' type: string - nat_address_v6: - description: 'The NAT IPV6 address. + network_policysetstack_id: + description: 'The network policy stack ID. ' type: string - nat_pools: - description: 'The NAT pools information. - - ' - items: - $ref: '#/components/schemas/NatPool' - type: array - nat_port: - description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part - of logical interface groups. + priority_policysetstack_id: + description: 'The priority policy set stack ID. ' - format: int32 - type: integer - nat_port_v6: - description: "The NAT IPv6 port.Internet bypass ports cannot be part of\ - \ logical interface groups. \n" - format: int32 - type: integer - nat_zone_id: - description: 'The NAT zone ID. + type: string + role: + description: 'The element role. ' + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - network_context_id: - description: 'The network context ID. + serial_number: + description: 'The serial number. ' type: string - parent: - description: 'The parent value = true. + site_id: + description: 'The site ID. ' type: string - peer_bypasspair_wan_port_type: - description: 'The peer bypass pair WAN port type. + software_version: + description: 'The software version. ' - enum: - - none - - cellular type: string - poe_enabled: - description: 'PoE enabled = true/false. - - ' - type: boolean - power_usage_threshold: - description: 'The interface config PoE power usage threshold. Valid values - are in the range 50-100. - - ' - format: int32 - type: integer - pppoe_config: - $ref: '#/components/schemas/PppoEInterfaceConfig' - description: 'The PPPoE config information. - - ' - scope: - description: 'The network scope. + state: + description: 'The element state. ' enum: - - GLOBAL - - LOCAL - type: string - secondary_ip_configs: - description: 'The interface secondary IP config. Secondary IPs exceed the - supported limit of 8. - - ' - items: - $ref: '#/components/schemas/SecondaryIPConfig' - type: array - service_link_config: - $ref: '#/components/schemas/ServiceLinkV2' - description: 'The interface secondary IP config. Secondary IPs exceed the - supported limit of 8. - - ' - site_wan_interface_ids: - description: 'The site WAN interface IDs. - - ' - items: - description: Site Wan Interface Ids - type: string - type: array - static_arp_configs: - description: 'The static ARP config details. - - ' - items: - $ref: '#/components/schemas/StaticARPConfig' - type: array - sub_interface: - $ref: '#/components/schemas/SubInterface' - description: 'The sub interface vlan ID. - - ' - switch_port_config: - $ref: '#/components/schemas/SwitchPortConfig' - description: 'The switch port config details. - - ' - tags: - description: 'A information field that can be added to identify the interface. - Maximum 10 Unique tags of length 1024 each are allowed. - - ' - items: - description: Tags - type: string - type: array - type: - description: 'The interface type. - - ' - type: string - used_for: - description: 'The interface used for value. The allowed values are public,private_wan,lan,none. - - ' + - 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 - vlan_config: - $ref: '#/components/schemas/VlanConfig' - description: 'The VLAN config details. - - ' - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. - - ' + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' type: string required: - - peer_bypasspair_wan_port_type - - scope - - used_for - - type - InterfaceV4N17: + - site_id + - tenant_id + ElementV2N2: properties: - admin_up: - description: 'The interface admin state. - - ' - type: boolean - attached_lan_networks: - description: 'The attached lan network ID and vlan ID. - - ' - items: - $ref: '#/components/schemas/LanNetworkVlanMapping' - type: array - authentication_config: - $ref: '#/components/schemas/AuthenticationInterfaceConfig' - description: 'The authentication config details. - - ' - bound_interfaces: - description: 'The bound interfaces. - - ' + admin_action: + description: Admin Action + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID + type: string + allowed_roles: + description: Allowed Roles items: - description: Bound Interfaces + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string type: array - bypass_pair: - $ref: '#/components/schemas/BypassPairV2' - description: 'The details of the bypass pair. - - ' - cellular_config: - $ref: '#/components/schemas/CellularInterfaceConfig' - description: 'The cellular config details. - - ' - description: - description: 'The interface description. Max size = 256. - - ' - devicemgmt_policysetstack_id: - description: 'The device management policy set stack ID. - - ' + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - dhcp_relay: - $ref: '#/components/schemas/DHCPRelay' - description: 'The DHCP relay information. - - ' - directed_broadcast: - description: 'The directed broadcast. - - ' + cluster_member_id: + description: Cluster Member Id + type: string + connected: + description: Connected type: boolean - ethernet_port: - $ref: '#/components/schemas/EthernetPort' - description: 'The ethernet port information. - - ' - id: - description: 'The interface ID. - - ' + 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 - interface_profile_id: - description: 'The interface profile ID. - - ' + description: + description: Description type: string - ipfixcollectorcontext_id: - description: 'The IPFIX collector context ID. - - ' + hw_id: + description: Hw Id type: string - ipfixfiltercontext_id: - description: 'The IPFIX filter context ID. - - ' + id: + description: Id type: string - ipv4_config: - $ref: '#/components/schemas/Ipv4Config' - description: 'The ipv4 config information. - - ' - ipv6_config: - $ref: '#/components/schemas/Ipv6ConfigV1' - description: 'The ipv6 config information. - - ' - lldp_enabled: - description: 'If LLDP enabled. True/False. - - ' + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding type: boolean - mac_address: - description: 'The interface configuration MAC address. - - ' + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + model_name: + description: Model Name type: string - mtu: - description: 'The MTU value of the interface. - - ' - type: integer - multicast_config: - $ref: '#/components/schemas/MulticastInterfaceConfig' - description: 'The multicast config details. - - ' name: - description: 'The name of the interface state. Max size = 128. - - ' + description: Name type: string - nat_address: - description: 'The NAT IP address. - - ' + network_policysetstack_id: + description: Network Policysetstack Id type: string - nat_address_v6: - description: 'The NAT IPV6 address. - - ' + priority_policysetstack_id: + description: Priority Policysetstack Id type: string - nat_pools: - description: 'The NAT pools information. - - ' - items: - $ref: '#/components/schemas/NatPool' - type: array - nat_port: - description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part - of logical interface groups. - - ' - format: int32 - type: integer - nat_port_v6: - description: "The NAT IPv6 port.Internet bypass ports cannot be part of\ - \ logical interface groups. \n" - format: int32 - type: integer - nat_zone_id: - description: 'The NAT zone ID. - - ' + role: + description: Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - network_context_id: - description: 'The network context ID. - - ' + serial_number: + description: Serial Number type: string - parent: - description: 'The parent value = true. - - ' + site_id: + description: Site Id type: string - peer_bypasspair_wan_port_type: - description: 'The peer bypass pair WAN port type. - - ' - enum: - - none - - cellular + software_version: + description: Software Version type: string - poe_enabled: - description: 'PoE enabled = true/false. - - ' - type: boolean - power_usage_threshold: - description: 'The interface config PoE power usage threshold. Valid values - are in the range 50-100. - - ' - format: int32 - type: integer - pppoe_config: - $ref: '#/components/schemas/PppoEInterfaceConfig' - description: 'The PPPoE config information. - - ' - scope: - description: 'The network scope. - - ' + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV1' + description: Spoke Ha Config + state: + description: State enum: - - GLOBAL - - LOCAL + - 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 - secondary_ip_configs: - description: 'The interface secondary IP config. Secondary IPs exceed the - supported limit of 8. - - ' - items: - $ref: '#/components/schemas/SecondaryIPConfig' - type: array - service_link_config: - $ref: '#/components/schemas/ServiceLinkV2' - description: 'The interface secondary IP config. Secondary IPs exceed the - supported limit of 8. - - ' - site_wan_interface_ids: - description: 'The site WAN interface IDs. - - ' - items: - description: Site Wan Interface Ids - type: string - type: array - static_arp_configs: - description: 'The static ARP config details. - - ' - items: - $ref: '#/components/schemas/StaticARPConfig' - type: array - sub_interface: - $ref: '#/components/schemas/SubInterface' - description: 'The sub interface vlan ID. - - ' - switch_port_config: - $ref: '#/components/schemas/SwitchPortConfig' - description: 'The switch port config details. - - ' tags: - description: 'A information field that can be added to identify the interface. - Maximum 10 Unique tags of length 1024 each are allowed. - - ' + description: Tags items: description: Tags type: string type: array - type: - description: 'The interface type. - - ' - type: string - used_for: - description: 'The interface used for value. The allowed values are public,private_wan,lan,none. - - ' - type: string - vlan_config: - $ref: '#/components/schemas/VlanConfig' - 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 - InventoryOperation: - enum: - - claim - - return - - revoke - - reuse - - retire - - recover - - remanufacture - - default - - invalid - - esp_allocate - - esp_received_stock - - esp_return - - esp_revoke - - esp_reuse - type: string - Ipv4Config: - properties: - dhcp_config: - $ref: '#/components/schemas/Ipv4Dhcp' - description: 'The DHCP config information. - - ' - dns_v4_config: - $ref: '#/components/schemas/DNS' - description: 'The DNS v4 config details. - - ' - pppoe_config: - $ref: '#/components/schemas/Ipv4Pppoe' - description: 'The PPoE config information. - - ' - routes: - description: 'The ethernet port routes. - - ' - items: - $ref: '#/components/schemas/Route' - type: array - static_config: - $ref: '#/components/schemas/Ipv4Static' - description: 'The IPv4 static address. - - ' - type: - description: 'The interface config type. Max = 12. - - ' - type: string - Ipv4Dhcp: - properties: - client_id: - description: 'The client ID. - - ' - type: string - hostname: - description: 'The IPv4 DHCP host name. - - ' + tenant_id: + description: Tenant Id type: string - Ipv4Pppoe: + ElementV2N3: properties: - chap_passwd: - description: 'The PPPoE IPv4 CHAP password. - - ' - type: string - chap_user: - description: 'The PPPoE IPv4 CHAP user. - - ' + admin_action: + description: Admin Action + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID type: string - set_route: - description: "The set route for PPPoE IPv4. \n" - type: boolean - Ipv4Static: - properties: - address: - description: Address + admin_renew_state: + description: Admin Renew State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - Ipv6ConfigV1: - properties: - dhcp_config: - $ref: '#/components/schemas/Ipv6Dhcp' - description: "The DHCP config information. \n" - dns_v6_config: - $ref: '#/components/schemas/DNS' - description: 'The DNS V6 configurations. - - ' - routes: - description: 'The route details. - - ' + allowed_roles: + description: Allowed Roles items: - $ref: '#/components/schemas/Route' + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string type: array - static_config: - $ref: '#/components/schemas/Ipv6StaticV1' - description: 'The IPv6 static address. - - ' - type: - description: 'The interface config type. Max = 12. - - ' - type: string - Ipv6Dhcp: - properties: - client_id: - description: 'The client ID. - - ' - type: string - hostname: - description: 'The IPv6 DHCP host name. - - ' - type: string - Ipv6Route: - properties: - destination: - description: 'The route destination. - - ' - type: string - via: - description: 'The via IPv6 address. - - ' + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - Ipv6StaticV1: - properties: - address: - description: 'The IPv6 static address. - - ' + cluster_member_id: + description: Cluster Member Id type: string - enable_prefix_distribution: - description: 'Is prefix distribution enabled. True or False. - - ' + connected: + description: Connected type: boolean - LanNetworkVlanMapping: - properties: - lan_network_id: - description: 'The LAN network ID. - - ' + 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 - vlan_id: - description: 'The VLAN ID. VLAN ID should be between 0 and 4095. - - ' - format: int32 - type: integer - LedConfig: - properties: - service_led_on: - description: Service Led On - type: boolean - 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. - - ' + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string - next_query: - description: 'Details of the next query. - - ' - type: object - tenant_id: - description: 'The tenant ID. - - ' + hw_id: + description: Hw 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. - - ' + description: Id type: string - tenant_id: - description: 'The tenant ID. - - ' + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + model_name: + description: Model Name type: string - type: object - 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" + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - local_ip_address: - description: 'The local probe address. - - ' + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string - proxy_id: - description: 'The proxy ID. - - ' + network_policysetstack_id: + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - Machine: - properties: - connected: - description: "The device is connected. True or False. \n" - type: boolean - console_conf_passphrase: - description: "The console password. \n" + priority_policysetstack_id: + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string - em_element_id: - description: "The element ID. \n" + role: + description: Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - hw_id: - description: 'The hardware ID. - - ' + serial_number: + description: Serial Number type: string - id: - description: Id + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' type: string - image_version: - description: 'The image version. - - ' + software_version: + description: Software Version type: string - inventory_op: - description: 'The inventory lifecycle values. - - ' + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV1' + description: 'Spoke Ha Config: Valid ' + 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 + 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) ' + items: + description: Tags + 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 + type: boolean + required: + - site_id + - tenant_id + ElementV2N4: + properties: + admin_action: + description: Admin Action enum: + - ALLOCATE - CLAIM + - BOUND + - UNBOUND + - DECLAIM - RETURN - REVOKE - - REUSE - RETIRE - - RECOVER + - STOCK + - UPGRADE - REMANUFACTURE - DEFAULT - INVALID - - ALLOCATE - - RECEIVED_STOCK - - ESP_ALLOCATE - - ESP_RECEIVED_STOCK - - ESP_RETURN - - ESP_REVOKE - - ESP_REUSE type: string - machine_state: - description: 'The various device states. - - ' + admin_renew_state: + description: Admin Renew State 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. - - ' + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - model_name: - description: "The model name of the device. \n" + allowed_roles: + description: Allowed Roles + items: + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + type: array + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - ordering_info: - description: "The order information. \n" + cluster_member_id: + description: Cluster Member Id type: string - pki_op: - $ref: '#/components/schemas/CAStoreOperation' - description: Pki Op - renew_state: - description: 'The device renew states. - - ' + connected: + description: Connected + type: boolean + deployment_op: + description: Deployment Op 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: - 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 - required: - - ship_state - - manufacture_id - - renew_state - - machine_state - - image_version - - model_name - - sl_no - - hw_id - - tenant_id - MachineInfoV2N3: - properties: - connected: - description: "The device is connected. True or False. \n" - type: boolean - console_conf_passphrase: - description: "The console password. \n" - type: string - em_element_id: - description: "The element ID. \n" + - 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 - esp_tenant_id: - description: 'The MSP tenant ID. - - ' + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string hw_id: - description: 'The hardware ID. - - ' + description: Hw Id type: string id: + description: Id type: string - image_version: - description: 'The image version. - - ' + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + model_name: + description: Model Name type: string - inventory_op: - $ref: '#/components/schemas/InventoryOperation' - description: 'The inventory lifecycle values. - - ' - machine_state: - $ref: '#/components/schemas/MachineState' - description: 'The various device states. - - ' - manufacture_id: - description: 'The manufacture ID. - - ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - model_name: - description: "The model name of the device. \n" + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string - ordering_info: - description: "The order information. \n" + network_policysetstack_id: + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - owner_tenant_id: - description: "The owner tenant ID. \n" + priority_policysetstack_id: + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string - pki_op: - $ref: '#/components/schemas/CAStoreOperation' - renew_state: - $ref: '#/components/schemas/MachineState' - description: 'The device renew states. - - ' - sales_order_number: - description: 'The sales order number. - - ' + role: + description: Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - ship_state: - $ref: '#/components/schemas/MachineShipState' - description: 'The shipping status. - - ' - sl_no: + serial_number: + description: Serial Number type: string - tenant_id: - description: 'The tenant ID. - - ' + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' type: string - token: - description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. - - ' + software_version: + description: Software Version type: string - type: object - MachineQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of machines that match the query parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number machines deleted for a time frame. - - ' - type: boolean - group_by: - description: 'Group the machines for the query. - - ' + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + 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 + 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) ' items: - description: Group By + description: Tags type: string type: array - id: - description: "List the machines by ID. \n" + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' 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. - - ' + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding 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 - MachineQueryFilterV2N3: + required: + - site_id + - tenant_id + ElementV2N5: properties: - connected: - description: "The device is connected. True or False. \n" - type: boolean - console_conf_passphrase: - description: "The console password. \n" - type: string - em_element_id: - description: "The element ID. \n" - type: string - esp_tenant_id: - description: 'The MSP tenant ID. - - ' - type: string - hw_id: - description: 'The hardware ID. - - ' - type: string - id: - description: Id - type: string - image_version: - description: 'The image version. - - ' - type: string - inventory_op: - description: 'The inventory lifecycle values. - - ' + admin_action: + description: Admin Action enum: + - ALLOCATE - CLAIM + - BOUND + - UNBOUND + - DECLAIM - RETURN - REVOKE - - REUSE - RETIRE - - RECOVER + - STOCK + - UPGRADE - REMANUFACTURE - DEFAULT - INVALID - - ALLOCATE - - RECEIVED_STOCK - - ESP_ALLOCATE - - ESP_RECEIVED_STOCK - - ESP_RETURN - - ESP_REVOKE - - ESP_REUSE type: string - machine_state: - description: 'The various device states. - - ' + admin_renew_state: + description: Admin Renew State 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. - - The manufacture ID. - - ' - type: string - model_name: - description: "The model name of the device. \n" - type: string - ordering_info: - description: "The order information. \n" - type: string - owner_tenant_id: - description: "The owner tenant ID. \n" + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - pki_op: - $ref: '#/components/schemas/CAStoreOperation' - description: Pki Op - renew_state: - description: 'The device renew states. - - ' + admin_suspend_state: + description: Admin Suspend State 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 + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - sales_order_number: - description: 'The sales order number. - - ' + allowed_roles: + description: Allowed Roles + items: + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + type: array + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - ship_state: - description: 'The shipping status. - - ' + cluster_member_id: + description: Cluster Member Id + type: string + connected: + description: Connected + type: boolean + deployment_op: + description: Deployment Op enum: - - MACHINE_SHIPPED - - MACHINE_SHIPPED_CORRECT_ADDRESS - - MACHINE_SHIPPED_WRONG_ADDRESS - - MACHINE_NOT_SHIPPED + - 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 - sl_no: - description: Sl No + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string - suspend_state: - description: 'The suspend state. - - ' + fips_mode: + description: Fips Mode 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 + - none + - fips + - non_fips type: string - tenant_id: - description: 'The tenant ID. - - ' + fips_mode_change_start_time: + description: Fips Mode Change Start Time + format: int64 + type: integer + hw_id: + description: Hw Id type: string - token: - description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. - - ' + id: + description: Id type: string - MachineQueryFilterV2N5: - properties: - connected: - description: "The device is connected. True or False. \n" + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding type: boolean - console_conf_passphrase: - description: "The console password. \n" - type: string - element_shell_id: - description: "The element shell ID. \n" + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + model_name: + description: Model Name type: string - em_element_id: - description: 'The element ID. - - ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - esp_tenant_id: - description: 'The MSP tenant ID. - - ' + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string - hw_id: - description: 'The hardware ID. - - ' + network_policysetstack_id: + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - id: - description: Id + priority_policysetstack_id: + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string - image_version: - description: 'The image version. - - ' + role: + description: Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - inventory_op: - description: 'The inventory lifecycle values. - - ' + 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_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + 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 + 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) ' + items: + description: Tags + 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 + type: boolean + required: + - site_id + - tenant_id + ElementV2N6: + properties: + admin_action: + description: Admin Action enum: + - ALLOCATE - CLAIM + - BOUND + - UNBOUND + - DECLAIM - RETURN - REVOKE - - REUSE - RETIRE - - RECOVER + - STOCK + - UPGRADE - REMANUFACTURE - DEFAULT - INVALID - - ALLOCATE - - RECEIVED_STOCK - - ESP_ALLOCATE - - ESP_RECEIVED_STOCK - - ESP_RETURN - - 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. - - ' + admin_renew_state: + description: Admin Renew State 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. - - ' - type: string - model_name: - description: "The model name of the device. \n" - type: string - ordering_info: - description: "The order information. \n" - type: string - owner_tenant_id: - description: "The owner tenant ID. \n" + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - pki_op: - $ref: '#/components/schemas/CAStoreOperation' - description: Pki Op - renew_state: - description: 'The device renew states. - - ' + admin_suspend_state: + description: Admin Suspend State 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 + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - sales_order_number: - description: 'The sales order number. - - ' + allowed_roles: + description: Allowed Roles + items: + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + type: array + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - ship_state: - description: 'The shipping status. - - ' + cluster_member_id: + description: Cluster Member Id + type: string + connected: + description: Connected + type: boolean + deployment_op: + description: Deployment Op enum: - - MACHINE_SHIPPED - - MACHINE_SHIPPED_CORRECT_ADDRESS - - MACHINE_SHIPPED_WRONG_ADDRESS - - MACHINE_NOT_SHIPPED + - 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 - sl_no: - description: Sl No + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string - suspend_state: - description: 'The suspend state. - - ' + device_profile_id: + description: Device Profile Id + type: string + fips_mode: + description: Fips Mode 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 + - none + - fips + - non_fips type: string - tenant_id: - description: 'The tenant ID. - - ' + fips_mode_change_start_time: + description: Fips Mode Change Start Time + format: int64 + type: integer + hw_id: + description: Hw Id type: string - token: - description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. - - ' + id: + description: Id type: string - MachineShipState: - enum: - - machine_shipped - - machine_shipped_correct_address - - machine_shipped_wrong_address - - machine_not_shipped - type: string - MachineState: - enum: - - manufactured - - manufactured_qa_pending - - manufactured_qa_ok - - manufactured_qa_not_ok - - manufactured_battery_test_pending - - manufactured_battery_test_start - - manufactured_battery_test_passed - - 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 - - allocated - - allocated_to_esp - - claim_pending - - initializing - - initialization_failed - - assigned - - claim_pending - - claimed - - claim_failed - - to_be_returned - - returned - - revoked - - machine_element_delete_pending - - return_failed - - received_stock - - remanufactured - - retired - - recover - - 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 - type: string - MachineSystemStatusV2N1: - properties: - boot_mode: - description: "The possible values in the boot mode. \n" - enum: - - BIOS - - UEFI_ONLY - - UEFI_SECURE + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + 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) ' + format: int32 + type: integer + model_name: + description: Model Name type: string - disk_status: - description: "The status details of the disk. \n" - items: - $ref: '#/components/schemas/DiskPartitionStatus' - type: array - fips_mode: - description: "The possible values in the FIPs. \n" - enum: - - none - - fips - - non_fips + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - hardware_id: - description: "The machine hardware ID. \n" + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string - id: - description: 'The machine ID. - - ' + network_policysetstack_id: + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - tpm_status: - description: 'The TPM status. - - ' + override_indicator: + description: Override Indicator + items: + description: Override Indicator + type: string + type: array + priority_policysetstack_id: + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string - trusted_boot: - description: 'The possible values in trusted boot. - - ' + role: + description: Role enum: - - PASSED - - FAILED - type: string - required: - - hardware_id - MachineV2N3: - properties: - connected: - description: "The device is connected. True or False. \n" - type: boolean - console_conf_passphrase: - description: "The console password. \n" + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - em_element_id: - description: "The element ID. \n" + serial_number: + description: Serial Number type: string - esp_tenant_id: - description: 'The MSP tenant ID. - - ' + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' type: string - hw_id: - description: 'The hardware ID. - - ' + software_version: + description: Software Version type: string - id: - description: Id + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + 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 - image_version: - description: 'The image version. - - ' + switch_config: + $ref: '#/components/schemas/SwitchConfig' + description: 'Switch Config: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' type: string - inventory_op: - description: 'The inventory lifecycle values. - - ' + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding + type: boolean + required: + - site_id + - tenant_id + ElementV2N7: + properties: + admin_action: + description: Admin Action enum: + - ALLOCATE - CLAIM + - BOUND + - UNBOUND + - DECLAIM - RETURN - REVOKE - - REUSE - RETIRE - - RECOVER + - STOCK + - UPGRADE - REMANUFACTURE - DEFAULT - INVALID - - ALLOCATE - - RECEIVED_STOCK - - ESP_ALLOCATE - - ESP_RECEIVED_STOCK - - ESP_RETURN - - ESP_REVOKE - - ESP_REUSE - type: string - machine_state: - 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. - - ' - type: string - model_name: - description: "The model name of the device. \n" - type: string - ordering_info: - description: "The order information. \n" - type: string - owner_tenant_id: - description: "The owner tenant ID. \n" type: string - pki_op: - $ref: '#/components/schemas/CAStoreOperation' - description: Pki Op - renew_state: - description: 'The device renew states. - - ' + admin_renew_state: + description: Admin Renew State 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 + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - sales_order_number: - description: 'The sales order number. - - ' + admin_suspend_state: + description: Admin Suspend State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - ship_state: - description: 'The shipping status. - - ' + allowed_roles: + description: Allowed Roles + items: + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + type: array + cluster_insertion_mode: + description: Cluster Insertion Mode + type: string + cluster_member_id: + description: Cluster Member Id + type: string + connected: + description: Connected + type: boolean + deployment_op: + description: Deployment Op enum: - - MACHINE_SHIPPED - - MACHINE_SHIPPED_CORRECT_ADDRESS - - MACHINE_SHIPPED_WRONG_ADDRESS - - MACHINE_NOT_SHIPPED + - 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 - sl_no: - description: 'The serial number. - - ' + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string - suspend_state: - description: 'The suspend state. - - ' + device_profile_id: + description: Device Profile Id + type: string + fips_mode: + description: Fips Mode 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 + - none + - fips + - non_fips type: string - tenant_id: - description: 'The tenant ID. - - ' + fips_mode_change_start_time: + description: Fips Mode Change Start Time + format: int64 + type: integer + hw_id: + description: Hw Id type: string - token: - description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. - - ' + id: + description: Id type: string - 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" + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding type: boolean - console_conf_passphrase: - description: "The console password. \n" + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + led_config: + $ref: '#/components/schemas/LedConfig' + description: 'Led Config: Valid ' + 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) ' + format: int32 + type: integer + model_name: + description: Model Name type: string - element_shell_id: - description: "The element shell ID. \n" + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - em_element_id: - description: 'The element ID. - - ' + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string - esp_tenant_id: - description: 'The MSP tenant ID. - - ' + network_policysetstack_id: + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - hw_id: - description: 'The hardware ID. - - ' + override_indicator: + description: Override Indicator + items: + description: Override Indicator + type: string + type: array + priority_policysetstack_id: + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string - id: - description: Id + role: + description: Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - image_version: - description: 'The image version. - - ' + serial_number: + description: Serial Number type: string - inventory_op: - description: 'The inventory lifecycle values. + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + software_version: + description: Software Version + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + 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 + switch_config: + $ref: '#/components/schemas/SwitchConfig' + description: 'Switch Config: Valid ' + 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) ' + items: + description: Tags + 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 + type: boolean + required: + - site_id + - tenant_id + ElementV3: + properties: + admin_action: + description: 'The values of admin actions that can be performed. ' enum: + - ALLOCATE - CLAIM + - BOUND + - UNBOUND + - DECLAIM - RETURN - REVOKE - - REUSE - RETIRE - - RECOVER + - STOCK + - UPGRADE - REMANUFACTURE - DEFAULT - INVALID - - ALLOCATE - - RECEIVED_STOCK - - ESP_ALLOCATE - - ESP_RECEIVED_STOCK - - ESP_RETURN - - 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. + admin_renew_state: + description: 'The values of admin renew state. ' 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. - - ' - type: string - model_name: - description: "The model name of the device. \n" - type: string - ordering_info: - description: "The order information. \n" - type: string - owner_tenant_id: - description: "The owner tenant ID. \n" + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - pki_op: - $ref: '#/components/schemas/CAStoreOperation' - description: Pki Op - renew_state: - description: 'The device renew states. - - ' + admin_suspend_state: + description: "The values of the admin suspend state. \n" 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 + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - sales_order_number: - description: 'The sales order number. + 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_id: + description: 'The spoke HA config cluster ID. ' type: string - ship_state: - description: 'The shipping status. + connected: + description: 'The element is connected. True or False. + + ' + type: boolean + deployment_op: + description: 'The deployment values. ' enum: - - MACHINE_SHIPPED - - MACHINE_SHIPPED_CORRECT_ADDRESS - - MACHINE_SHIPPED_WRONG_ADDRESS - - MACHINE_NOT_SHIPPED - type: string - sl_no: - description: Sl No + - 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 - suspend_state: - description: 'The suspend state. + description: + description: 'The description of the element. ' - 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 - tenant_id: - description: 'The tenant ID. - - ' - type: string - token: - description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. + device_profile_id: + description: 'The device profile ID. ' type: string - MulticastInterfaceConfig: - properties: - igmp_version: - description: 'The IGMP version. + fips_mode: + description: 'The FIPs mode. ' enum: - - IGMPV2 - - IGMPV3 + - none + - fips + - non_fips type: string - multicast_enabled: - description: 'Is multicast enabled. True or False. + fips_mode_change_start_time: + description: 'The FIPs mode change starting time. ' - type: boolean - NatPool: - properties: - ipv4_ranges: - description: 'The NAT Ipv4 address ranges. Minimum 1 and maximum 4 nat pool - IP ranges can be specified. + format: int64 + type: integer + hw_id: + description: 'The hardware ID. ' - items: - $ref: '#/components/schemas/IPv4Range' - type: array - nat_pool_id: - description: 'The NAT pool ID. + type: string + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: 'The L3 direct private WAN is enabled. True or False. ' - 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. + 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 - PeerInfo: - properties: - hostname: - description: 'The peer hostname. + led_config: + $ref: '#/components/schemas/LedConfig' + description: 'Valid LED config. ' + main_power_usage_threshold: + description: "The main power usage threshold. Allowed range is 50-100. \ + \ \n" + format: int32 + type: integer + model_name: + description: "The model name of the device. \n" type: string - ip_addresses: - description: 'The peer IP addresses. Max size = 4. - - ' - items: - description: Ip Addresses - type: string - type: array - PoeStateS: - properties: - detection_status: - description: 'The PoE detection status. + name: + description: 'The name of the device. ' type: string - device_type: - description: 'The ION device type. + nat_policysetstack_id: + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. ' type: string - operational_state: - description: "The PoE operational state. \n" - type: string - poe_enabled: - description: "Indicates if PoE is enabled. By default, PoE is disabled.\ - \ \n" - type: boolean - power_classification: - description: "The power classification. \n" - type: string - power_consumed: - description: 'The power consumed. + network_policysetstack_id: + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. ' - format: float - type: number - power_pairs_control_ability: - description: 'Values = True or False. + type: string + override_indicator: + description: 'The override indicator. ' - type: boolean - power_pairs_state: - description: 'The power pair state. + items: + description: Override Indicator + type: string + type: array + priority_policysetstack_id: + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. ' type: string - power_priority: - description: 'The power priority. + role: + description: 'The element role. ' + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - power_usage_threshold: - description: 'The Port Power Usage Alarm Threshold value is between 50 - - 100%.The default threshold is 100% (60W). + serial_number: + description: 'The serial number. ' - format: int32 - type: integer - Port: - properties: - end: - description: 'The end port range must be between 1 and 65535. + type: string + site_id: + description: 'The site ID. ' type: string - start: - description: 'The start port range must be between 1 and 65535. + software_version: + description: 'The software version. ' type: string - PppoEInterfaceConfig: - properties: - host_uniq: - description: 'The host. + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'The details of the spoke HA configuration. ' - type: string - ip_address_type: - description: 'IPv4 and IPv6 addresses. + 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 - password: - description: 'The password for the PPOE interface configuration. + switch_config: + $ref: '#/components/schemas/SwitchConfig' + description: 'The details of the switch configuration. ' - type: string - reconnection_delay: - description: 'The recoonection delay value. + tags: + description: 'A information field that can be added to identify the element. ' - format: int32 - type: integer - service_name: - description: 'The name of the service used for the PPPoE configuration. + items: + description: Tags + type: string + type: array + tenant_id: + description: 'The tenant ID. ' type: string - username: - description: 'The username for the PPPoE interface configuration. + vpn_to_vpn_forwarding: + description: 'VPN to VPN forwarding. True or False. ' - 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: Hardware Id - type: string - id: - description: Id - type: string - ion_token: - description: Ion Token - type: string - is_used: - description: Is Used type: boolean - secret_token: - description: Secret Token - type: string - token_validity_in_hour: - description: Token Validity In Hour - format: int32 - type: integer - valid_till_secs: - description: Valid Till Secs - format: int64 - type: integer - RecoveryTokenScreen: + required: + - site_id + - tenant_id + Error: properties: - id: - description: 'The recovery token ID. + _error: + items: + $ref: '#/components/schemas/ErrorResponse' + type: array + ErrorResponse: + properties: + code: + description: 'The error code. ' type: string - token_validity_in_hour: - description: 'The token validity in a hour. + message: + description: 'The error message. ' - format: int32 - type: integer - Route: + type: string + Ethernet: properties: - destination: - description: 'The route destination. + connector: + description: "The ethernet connector type. \n" + type: string + device: + description: "The device name. \n" + type: string + disabled: + description: 'Disable the port. + + ' + type: boolean + disabled_reason: + description: 'Reason to disable the port. ' type: string - via: - description: 'The via IP address. + element_id: + description: 'Element ID. ' type: string - STPStateS: - properties: - bpdu_guard_enabled: - description: 'BPDU Guard enabled on ports do not receive a BPDU from its - connected devices. When a BPDU Guard enabled port receives BPDU from a - connected device, BPDU Guard disables the port. + id: + description: 'The connector ID. ' - type: boolean - forward_fast_enabled: - description: 'The speed. + type: string + inactive: + description: 'Port status (active or inactive). ' type: boolean - mstp_instance_id: - description: "The MSTP instance ID. \n" - format: int32 - type: integer - port_cost: - description: "The STP port cost is between 1-65535. The STP port cost depends\ - \ on the speed of the port. \n" - format: int32 - type: integer - port_priority: - description: "The STP Port priority is between 0-240. The default value\ - \ is 128, STP port priority is in multiples of 16. \n" - format: int32 - type: integer - port_state: - description: 'The port state. + inactive_reason: + description: 'Reason for port being inactive. ' type: string - root_guard_enabled: - description: 'Root Guard is enabled on a port-by-port basis, it prevents - a configured port from becoming a root port. Root Guard prevents a downstream - switch from becoming a root bridge in a topology. + max_mtu: + description: 'The MTU max value. ' - type: boolean - stp_enabled: - description: 'Spanning Tree Protocol (STP) is enabled by default. By default, - the STP type is RSTP. + type: integer + max_speed: + description: 'The max speed value. ' - type: boolean - SVIStateS: - properties: - stp_designated_cost: - description: "The STP designated cost between 1-65535. \n" - type: integer - stp_designated_mac_address: - description: "The STP designated MAC address. \n" - type: string - stp_designated_port: - description: "The STP designated port. \n" type: integer - stp_designated_root_mac_address: - description: 'The STP designated root MAC address. + name: + description: 'The name. ' 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: - description: Ipv4 Address - type: string - scope: - description: "The scope of the secondary IP config. \n" - type: string - ServiceLink: - properties: - anti_replay: - description: 'The anti replay value. True or False. + original_mac_address: + description: 'The MAC address. ' - type: boolean - anti_replay_window: - description: 'The anti replay window count. + type: string + region: + description: 'The region. ' - type: integer - classic_site_id: + type: string + 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. + tenant_id: + description: 'The tenant ID. + + ' + type: string + required: + - site_id + - tenant_id + EthernetPort: + properties: + full_duplex: + description: 'Interface running in full duplex mode. ' type: boolean - geneve_config: - $ref: '#/components/schemas/GeneveConfig' - description: 'Lists all the geneve configurations. + port_id: + $ref: '#/components/schemas/Ethernet' + description: 'The ethernet port ID. ' - gre_config: - $ref: '#/components/schemas/GREConfig' - description: 'The GRE config details. + port_name: + description: 'The ethernet port name. ' - ipsec_config: - $ref: '#/components/schemas/IPSECConfig' - description: 'The IPSec config details. + type: string + speed: + description: "The ethernet port speed. \n" + format: int32 + type: integer + Extension: + properties: + conf: + type: object + disabled: + description: 'List the disabled extensions. ' - last_parent: - description: 'The last parent value = true. + type: boolean + entity_id: + description: 'The entity ID. Only numbers are allowed (0-9). ' type: string - liveliness_probe: - $ref: '#/components/schemas/LivelinessProbe' - description: 'Lists the livliness probe details. + id: + description: 'The ID. ' - nat_traversal: - description: 'Nat traversal value. True or False. + type: string + name: + 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]+$. ' - type: boolean - pa_location_oid: - description: Pa Location Oid type: string - pa_tunnel_oid: - description: Pa Tunnel Oid + tenant_id: + description: "The tenant ID. \n" type: string - parent: - description: 'The parent value = true. + required: + - conf + - namespace + - name + - tenant_id + ExtensionQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of element level extensions that match + the query parameters. ' - type: string - passive_mode: - $ref: '#/components/schemas/PassiveMode' - description: 'Passive mode enabled on the device. True or False + dest_page: + description: 'The destination page. ' - peer: - $ref: '#/components/schemas/PeerInfo' - description: 'The peer information. + format: int32 + type: integer + getDeleted: + description: 'The number element level extensions deleted for a time frame. ' - proxy_ids: - description: 'The proxy details. + type: boolean + group_by: + description: 'Group the element level extensions for the query. ' items: - $ref: '#/components/schemas/Proxy' + description: Group By + type: string type: array - sase_ike_gw_config: - $ref: '#/components/schemas/SaseIkeGWConfig' - description: 'The SASE IKE GW configurations. + id: + description: "List the element level extensions by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. ' - security_service_endpoint_id: - description: 'The security service endpoint ID. + format: int64 + type: integer + limit: + description: 'The query limit. ' - type: string - service_endpoint_id: - description: 'The service endpoint ID. + format: int32 + type: integer + next_query: + description: 'The limit. ' - type: string - tunnel_role: - description: "The tunnel role. \n" - type: string - type: - description: 'The service link type. + type: object + query_params: + description: 'Query using query parameters. ' - enum: - - IPSEC - - GRE - - GENEVE - type: string - required: - - type - ServiceLinkV2: - properties: - gre_config: - $ref: '#/components/schemas/GREConfig' - description: 'The GRE config details. + type: object + retrieved_fields: + description: 'Retrieve information from a field. ' - ipsec_config: - $ref: '#/components/schemas/IPSECConfig' - description: 'The IPSec config details. + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. ' - last_parent: - description: 'The last parent value = true. + type: boolean + sort_params: + description: 'Specify the order in which you want the search criteria to + display. ' - type: string - parent: - description: 'The parent value = true. + type: object + total_count: + description: "The total number of query parameters. \n" + format: int64 + type: integer + ExtensionQueryFilter: + properties: + conf: + type: object + disabled: + description: 'List the disabled extensions. ' - type: string - peer: - $ref: '#/components/schemas/PeerInfo' - description: 'The peer information. + type: boolean + id: + description: 'The ID. ' - service_endpoint_id: - description: "The service endpoint ID. \n" type: string - type: - description: 'The service link type. + name: + 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]+$. ' - enum: - - IPSEC - - GRE - - GENEVE - type: string - required: - - type - Software: - properties: - location: - description: Location type: string - version: - description: Version + tenant_id: + description: "The tenant ID. \n" type: string - SpokeHAConfigV2: + required: + - conf + - namespace + - name + - tenant_id + ExtensionScreen: properties: - cluster_id: - description: "The spoke HA config cluster ID. \n" - type: string - enable: - description: "The spoke HA config enabled. True or False. \n" + conf: + type: object + disabled: + description: 'List the disabled extensions. + + ' type: boolean - priority: - description: "The priority of the spoke HA config. \n" - format: int32 - type: integer - source_interface: - description: 'The spoke HA config source interface ID. + entity_id: + description: 'The entity ID. Only numbers are allowed (0-9). ' type: string - track: - $ref: '#/components/schemas/TrackV2' - description: 'Track: Valid ' - required: - - source_interface - - priority - - enable - - cluster_id - StaticARPConfig: - properties: - ipv4_address: - description: 'The static APR IPv4 address. + id: + description: 'The ID. ' type: string - mac_address: - description: 'The MAC address. + name: + 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]+$. ' type: string - StormControlConfig: + required: + - conf + - namespace + - name + GREConfig: properties: - broadcast_threshold: - description: 'By default, the broadcast threshold is set to 1000kbps. Enter - a value between 64 -1000000 kbps. - - ' - type: integer - multicast_threshold: - description: 'Multicast threshold value is set between 64-1000000kbps. + csum: + description: 'The CSUM. ' - type: integer - unicast_threshold: - description: 'Unknown Unicast threshold value is set between 64-1000000 - kbps. + type: boolean + keepalive_enable: + description: 'Is keepalive enabled. True or False. ' - type: integer - SubInterface: - properties: - vlan_id: - description: Vlan Id - format: int32 - type: integer - SwitchConfig: - properties: - default_vlan_id: - description: 'Default VLAN ID is 1. + 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 - mstp_enabled: - description: 'The MSTP enabled. True or False. + 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. ' - type: boolean - stp_aging_timer: - description: "The STP aging Timer between 10 - 1000000 seconds. \ - \ \n" - format: int32 - type: integer - 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: "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: 'The length of Max Age time that the switch retains information - learned from BPDUs, set the value between 6 - 40 seconds. + HardwareBypass: + properties: + element_bypass: + description: "The information on the element bypass pair. \n" + items: + $ref: '#/components/schemas/BypassInfo' + type: array + id: + description: 'The ID. ' - format: int32 - type: integer - stp_mode: - description: 'The STP Mode is RSTP, default STP mode is RSTP + type: string + IKEV1Params: + properties: + xauth_id: + description: 'The xauth ID. ' - enum: - - RSTP type: string - stp_priority: - description: 'The Priority value is between 0 - 61440, in multiples of 4096. + xauth_secret: + description: 'The authentication secret. Length must be between 4-128. ' - format: int32 - type: integer - required: - - stp_mode - SwitchPortConfig: - properties: - access_vlan_id: - description: 'The VLAN access ID. + type: string + xauth_secret_encrypted: + description: "The xauth secret. Value = True. \n" + type: string + xauth_secret_hash: + description: 'The xauth hash. Value = True. ' - type: integer - bpdu_guard_enabled: - description: 'BPDU Guard enabled on ports do not receive a BPDU from its - connected devices. When a BPDU Guard enabled port receives BPDU from a - connected device, BPDU Guard disables the port. + type: string + xauth_type: + description: 'The xauth type. ' - type: boolean - forward_fast_enabled: - description: 'The speed. - - The attached lan network ID and vlan ID. + enum: + - NONE + - SECRET + type: string + required: + - xauth_type + IPSECAuthentication: + properties: + certificate: + description: 'The certificate authentication for the IPsec Profile. ' - type: boolean - native_vlan_id: - description: 'The VLAN ID. + type: string + ikev1_params: + $ref: '#/components/schemas/IKEV1Params' + description: 'Ikev1 Params: Valid ' + local_ca_certificate: + description: "The local CA certificate uploaded for certificate authentication.\ + \ \n" + type: string + local_id: + description: 'The local ID type. ' - type: integer - root_guard_enabled: - description: 'Root Guard is enabled on a port-by-port basis, it prevents - a configured port from becoming a root port. Root Guard prevents a downstream - switch from becoming a root bridge in a topology. + enum: + - LOCAL_IP + - DN + - HOSTNAME + - CUSTOM + type: string + local_id_custom: + description: 'The custom local ID. ' - type: boolean - storm_control_config: - $ref: '#/components/schemas/StormControlConfig' - description: 'Storm control config information. Threshold for traffic rate - limit, the traffic is rate limited for the set threshold value. + type: string + passphrase: + description: Passphrase + type: string + passphrase_encrypted: + description: 'Passphrase Encrypted: JsonIgnore(value = true) ' + type: string + private_key: + description: 'The private key file uploaded for certificate authentication. ' - stp_port_cost: - description: 'STP port cost between 1-65535. The STP port cost depends on - the speed of the port. + type: string + private_key_encrypted: + description: 'Private Key Encrypted: JsonIgnore(value = true) ' + type: string + remote_ca_certificate: + description: "The standard VPN endpoint CA certificate uploaded. \ + \ \n" + type: string + remote_id: + description: "The ID for the standard VPN endpoint in the Remote ID field.\ + \ \n" + type: string + secret: + description: "The password for PSK authentication. \n" + type: string + secret_encrypted: + description: 'Secret Encrypted: JsonIgnore(value = true) ' + type: string + secret_hash: + description: 'Secret Hash: JsonIgnore(value = true) ' + type: string + type: + description: 'The authentication type = PSK or Certificates. ' - format: int32 - type: integer - stp_port_enabled: - description: 'Spanning Tree Protocol (STP) port enabled. + enum: + - NONE + - PSK + - X509 + type: string + x509Objects: + $ref: '#/components/schemas/X509Objects' + description: 'X509Objects: JsonIgnore(value = true) ' + required: + - local_id + - type + IPSECConfig: + properties: + authentication: + $ref: '#/components/schemas/IPSECAuthentication' + description: 'The IPSec authentication details. + + ' + ipsec_profile_id: + description: 'The IPSec profile ID. + + ' + type: string + required: + - ipsec_profile_id + IPv4Range: + properties: + end: + description: 'The end IPv4 address. + + ' + type: string + start: + description: "The start IPv4 address. \n" + type: string + required: + - end + - start + IPv6DNS: + properties: + name_servers: + description: 'The IPv6 configured DNS name servers. + + ' + items: + description: Name Servers + type: string + type: array + search: + description: 'The search parameters. + + ' + items: + description: Search + type: string + type: array + InterfaceQueryResponseV4N10: + properties: + admin_up: + description: 'The interface admin state. ' type: boolean - stp_port_priority: - description: 'STP Port priority is between 0-240. The default value is 128, - STP port priority is in multiples of 16. + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. ' - format: int32 - type: integer - trunk_vlans: - description: 'The interface config switch port trunk VLANs. Max trunk VLANs - allowed is 32 and no duplicates are allowed. + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: 'The bound interfaces. ' items: - description: Trunk Vlans + description: Bound Interfaces type: string type: array - vlan_mode: - description: 'The VLAN mode. + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: 'The details of the bypass pair. ' - enum: - - access - - trunk - type: string - voice_vlan_id: - description: 'The voice VLAN ID. + description: + description: 'The interface description. Max size = 256. ' - type: integer - required: - - vlan_mode - SwitchState: - properties: - bridge_id: - description: 'The switch bridge ID + devicemgmt_policysetstack_id: + description: 'The device management policy set stack ID. ' type: string - default_vlan_id: - description: 'Default VLAN ID is 1. + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. ' - format: int32 - type: integer - designated_bridge_id: - description: "The designated bridge ID. \n" - type: string - last_topology_change: - description: 'Last topology change. + directed_broadcast: + description: 'The directed broadcast. + + ' + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. + + ' + id: + description: 'The interface ID. ' type: string - max_hops: - description: Max Hops - format: int32 - type: integer - mstp_enabled: - description: 'The MSTP enabled. True or False. + ipfixcollectorcontext_id: + description: 'The IPFIX collector context ID. ' - type: boolean - root_bridge_id: - description: Root Bridge Id type: string - root_path_cost: - description: Root Path Cost - format: int32 - type: integer - root_port: - description: Root Port + ipfixfiltercontext_id: + description: 'The IPFIX filter context ID. + + ' type: string - stp_aging_timer: - description: "The STP aging Timer between 10 - 1000000 seconds. \ - \ \n" - format: int32 - type: integer - 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: "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: 'The length of Max Age time that the switch retains information - learned from BPDUs, set the value between 6 - 40 seconds. + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. ' - format: int32 - type: integer - stp_mode: - description: 'The STP Mode is RSTP, default STP mode is RSTP + mac_address: + description: 'The interface configuration MAC address. ' type: string - stp_priority: - description: 'The Priority value is between 0 - 61440, in multiples of 4096. + mtu: + description: 'The MTU value of the interface. ' - format: int32 type: integer - TrackInterface: - properties: - interface_id: - description: 'The interface ID + name: + description: 'The name of the interface state. Max size = 128. ' type: string - reduce_priority: - description: 'Reduce priority of the spoke HA config. + nat_address: + description: 'The NAT IP address. ' - format: int32 - type: integer - TrackV2: - properties: - interfaces: - description: 'The details of the interfaces. + type: string + nat_pools: + description: 'The NAT pools information. ' items: - $ref: '#/components/schemas/TrackInterface' - type: array - waninterfaces: - description: 'Waninterfaces: Valid ' - items: - $ref: '#/components/schemas/TrackWANInterface' + $ref: '#/components/schemas/NatPool' type: array - TrackWANInterface: - properties: - reduce_priority: - description: 'Reduce priority of the spoke HA config. + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. ' format: int32 type: integer - wan_interface_id: - description: 'The WAN interface ID + nat_zone_id: + description: 'The NAT zone ID. ' type: string - VRF: - properties: - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. + network_context_id: + description: 'The network context ID. ' type: string - vrf_context_name: - description: 'The VFR context name. + parent: + description: 'The parent value = true. ' type: string - VffInventoryOperation: - enum: - - grant - - return - - revoke - type: string - VffLicense: - properties: - allowed_ions: - description: 'The number of allowed ions. - - ' - format: int32 - type: integer - id: - description: 'The ID of ION. + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'The PPPoE config information. ' - type: string - model: - description: 'The model of the ION. + scope: + description: 'The network scope. ' + enum: + - GLOBAL + - LOCAL type: string - required: - - model - VffLicenseQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of vff licenses that match the query - parameters. - - ' - dest_page: - description: 'The destination page. + secondary_ip_configs: + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. ' - format: int32 - type: integer - getDeleted: - description: 'The number of vff licenses deleted for a time frame. + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. ' - type: boolean - group_by: - description: 'Group the vff licenses for the query. + site_wan_interface_ids: + description: 'The site WAN interface IDs. ' items: - description: Group By + description: Site Wan Interface Ids type: string type: array - id: - description: "List the vff licenses 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. + static_arp_configs: + description: 'The static ARP config details. ' - type: object - query_params: - description: 'Query using query parameters. + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. ' - type: object - retrieved_fields: - description: 'Retrieve information from a field. + tags: + description: 'A information field that can be added to identify the interface. + 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: - 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 - VffLicenseState: - properties: - deployed_ions: - description: 'The number of deployed IONs. + type: + description: 'The interface type. ' - format: int32 - type: integer - id: - description: 'The ID of the vff license. + type: string + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. ' type: string - VffLicenseStateQuery: + required: + - scope + - used_for + - type + InterfaceQueryResponseV4N7: properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of vff license states that match the - query parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number of vff license states deleted for a time frame. - - ' + admin_up: + description: Admin Up type: boolean - group_by: - description: 'Group the vff license states for the query. - - ' + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' items: - description: Group By + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces type: string type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + element_id: + description: Element Id + type: string + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port id: - description: "List the vff license states by ID. \n" + description: Id type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. - - ' - format: int64 + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' type: integer - limit: - description: 'The query limit. - - ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' 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. - - ' + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids items: - description: Retrieved Fields + description: Site Wan Interface Ids type: string type: array - retrieved_fields_mask: - description: 'List the fields to query. + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceQueryResponseV4N8: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceQueryResponseV4N9: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + directed_broadcast: + description: Directed Broadcast + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N1: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPair' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - used_for + - type + InterfaceScreenV4N10: + properties: + admin_up: + description: 'The interface admin state. ' type: boolean - sort_params: - description: 'Specify the order in which you want the search criteria to - display. + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. ' - type: object - total_count: - description: 'The total number of query parameters. + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: 'The bound interfaces. ' - format: int64 - type: integer - VffLicenseStateV2: - properties: - deployed_ions: - description: 'The number of deployed IONs. + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: 'The details of the bypass pair. ' - format: int32 + description: + description: 'The interface description. Max size = 256. + + ' + devicemgmt_policysetstack_id: + description: 'The device management policy set stack ID. + + ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. + + ' + directed_broadcast: + description: 'The directed broadcast. + + ' + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. + + ' + id: + description: 'The interface ID. + + ' + type: string + ipfixcollectorcontext_id: + description: 'The IPFIX collector context ID. + + ' + type: string + ipfixfiltercontext_id: + description: 'The IPFIX filter context ID. + + ' + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. + + ' + mac_address: + description: 'The interface configuration MAC address. + + ' + type: string + mtu: + description: 'The MTU value of the interface. + + ' + type: integer + name: + description: 'The name of the interface state. Max size = 128. + + ' + type: string + nat_address: + description: 'The NAT IP address. + + ' + type: string + nat_pools: + description: 'The NAT pools information. + + ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. + + ' + format: int32 type: integer + nat_zone_id: + description: 'The NAT zone ID. + + ' + type: string + network_context_id: + description: 'The network context ID. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'The PPPoE config information. + + ' + scope: + description: 'The network scope. + + ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'The static ARP config details. + + ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. + + ' + tags: + description: 'A information field that can be added to identify the interface. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The interface type. + + ' + type: string + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. + + ' + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N11: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. + + ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: 'The bound interfaces. + + ' + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: 'The details of the bypass pair. + + ' + cellular_config: + $ref: '#/components/schemas/CellularInterfaceConfig' + description: 'Cellular Config: Valid ' + description: + description: 'The interface description. Max size = 256. + + ' + devicemgmt_policysetstack_id: + description: 'The device management policy set stack ID. + + ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. + + ' + directed_broadcast: + description: 'The directed broadcast. + + ' + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. + + ' id: - description: 'The ID of the vff license. + description: 'The interface ID. + + ' + type: string + ipfixcollectorcontext_id: + description: 'The IPFIX collector context ID. + + ' + type: string + ipfixfiltercontext_id: + description: 'The IPFIX filter context ID. + + ' + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. + + ' + mac_address: + description: 'The interface configuration MAC address. + + ' + type: string + mtu: + description: 'The MTU value of the interface. ' + type: integer + multicast_config: + $ref: '#/components/schemas/MulticastInterfaceConfig' + description: 'Multicast Config: Valid ' + name: + description: 'The name of the interface state. Max size = 128. + + ' + type: string + nat_address: + description: 'The NAT IP address. + + ' + type: string + nat_pools: + description: 'The NAT pools information. + + ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. + + ' + format: int32 + type: integer + nat_zone_id: + description: 'The NAT zone ID. + + ' + type: string + network_context_id: + description: 'The network context ID. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'The PPPoE config information. + + ' + scope: + description: 'The network scope. + + ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'The static ARP config details. + + ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. + + ' + tags: + description: 'A information field that can be added to identify the interface. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The interface type. + + ' + type: string + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. + + ' + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N12: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. + + ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: 'The bound interfaces. + + ' + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: 'The details of the bypass pair. + + ' + cellular_config: + $ref: '#/components/schemas/CellularInterfaceConfig' + description: 'Cellular Config: Valid ' + description: + description: 'The interface description. Max size = 256. + + ' + devicemgmt_policysetstack_id: + description: 'The device management policy set stack ID. + + ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. + + ' + directed_broadcast: + description: 'The directed broadcast. + + ' + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. + + ' + id: + description: 'The interface ID. + + ' + type: string + ipfixcollectorcontext_id: + description: 'The IPFIX collector context ID. + + ' + type: string + ipfixfiltercontext_id: + description: 'The IPFIX filter context ID. + + ' + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. + + ' + ipv6_config: + $ref: '#/components/schemas/Ipv6Config' + description: 'Ipv6 Config: Valid Valid ' + mac_address: + description: 'The interface configuration MAC address. + + ' + type: string + mtu: + description: 'The MTU value of the interface. + + ' + type: integer + multicast_config: + $ref: '#/components/schemas/MulticastInterfaceConfig' + description: 'Multicast Config: Valid ' + name: + description: 'The name of the interface state. Max size = 128. + + ' + type: string + nat_address: + description: 'The NAT IP address. + + ' + 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) ' + type: string + nat_pools: + description: 'The NAT pools information. + + ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. + + ' + format: int32 + type: integer + nat_port_v6: + description: 'Nat Port V6: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'The NAT zone ID. + + ' + type: string + network_context_id: + description: 'The network context ID. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'The PPPoE config information. + + ' + scope: + description: 'The network scope. + + ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'The static ARP config details. + + ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. + + ' + tags: + description: 'A information field that can be added to identify the interface. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The interface type. + + ' + type: string + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. + + ' + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N13: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + authentication_config: + $ref: '#/components/schemas/AuthenticationConfig' + description: 'Authentication Config: Valid ' + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + cellular_config: + $ref: '#/components/schemas/CellularInterfaceConfig' + description: 'Cellular Config: Valid ' + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + directed_broadcast: + description: Directed Broadcast + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + interface_profile_id: + description: Interface Profile Id + type: string + ipfixcollectorcontext_id: + description: Ipfixcollectorcontext Id + type: string + ipfixfiltercontext_id: + description: Ipfixfiltercontext Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + ipv6_config: + $ref: '#/components/schemas/Ipv6Config' + description: 'Ipv6 Config: Valid Valid ' + lldp_enabled: + description: Lldp Enabled + type: boolean + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + multicast_config: + $ref: '#/components/schemas/MulticastInterfaceConfig' + description: 'Multicast Config: Valid ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + 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) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_port_v6: + description: 'Nat Port V6: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + poe_enabled: + description: Poe Enabled + type: boolean + power_usage_threshold: + description: 'Power Usage Threshold: ValidateDecimal(allowZero = true, increment + = 0, max = 0, error = INTERFACE_CONFIG_INVALID_POE_POWER_USAGE_THRESHOLD: + Invalid Interface configuration. Invalid PoE alarm threshold value {}. + Valid values are in the range 50-100., min = 0) ' + format: int32 + type: integer + pppoe_config: + $ref: '#/components/schemas/PppoEInterfaceConfig' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'Secondary Ip Configs: Size(max = 8, error = INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT: + Invalid interface configuration. Secondary IPs exceed the supported limit + of 8, min = 0) ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'Static Arp Configs: Size(max = 32, error = INTERFACE_CONFIG_STATIC_ARP_EXCEEDS_LIMIT: + Invalid interface configuration. Static ARP entries exceed the supported + limit of 16, min = 0) ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + switch_port_config: + $ref: '#/components/schemas/SwitchPortConfig' + description: 'Switch Port Config: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + vlan_config: + $ref: '#/components/schemas/VlanConfig' + description: 'Vlan Config: Valid ' + required: + - scope + - used_for + - type + InterfaceScreenV4N14: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + authentication_config: + $ref: '#/components/schemas/AuthenticationConfig' + description: 'Authentication Config: Valid ' + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + cellular_config: + $ref: '#/components/schemas/CellularInterfaceConfig' + description: 'Cellular Config: Valid ' + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + directed_broadcast: + description: Directed Broadcast + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + interface_profile_id: + description: Interface Profile Id + type: string + ipfixcollectorcontext_id: + description: Ipfixcollectorcontext Id + type: string + ipfixfiltercontext_id: + description: Ipfixfiltercontext Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + ipv6_config: + $ref: '#/components/schemas/Ipv6Config' + description: 'Ipv6 Config: Valid Valid ' + lldp_enabled: + description: Lldp Enabled + type: boolean + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + multicast_config: + $ref: '#/components/schemas/MulticastInterfaceConfig' + description: 'Multicast Config: Valid ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + 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) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_port_v6: + description: 'Nat Port V6: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + poe_enabled: + description: Poe Enabled + type: boolean + power_usage_threshold: + description: 'Power Usage Threshold: ValidateDecimal(allowZero = true, increment + = 0, max = 0, error = INTERFACE_CONFIG_INVALID_POE_POWER_USAGE_THRESHOLD: + Invalid Interface configuration. Invalid PoE alarm threshold value {}. + Valid values are in the range 50-100., min = 0) ' + format: int32 + type: integer + pppoe_config: + $ref: '#/components/schemas/PppoEInterfaceConfig' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'Secondary Ip Configs: Size(max = 8, error = INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT: + Invalid interface configuration. Secondary IPs exceed the supported limit + of 8, min = 0) ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'Static Arp Configs: Size(max = 32, error = INTERFACE_CONFIG_STATIC_ARP_EXCEEDS_LIMIT: + Invalid interface configuration. Static ARP entries exceed the supported + limit of 16, min = 0) ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + switch_port_config: + $ref: '#/components/schemas/SwitchPortConfig' + description: 'Switch Port Config: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + vlan_config: + $ref: '#/components/schemas/VlanConfig' + description: 'Vlan Config: Valid ' + required: + - scope + - used_for + - type + InterfaceScreenV4N2: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - used_for + - type + InterfaceScreenV4N3: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - used_for + - type + InterfaceScreenV4N4: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N5: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N6: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N7: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N8: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N9: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + directed_broadcast: + description: Directed Broadcast + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceState: + properties: + cellular_state: + $ref: '#/components/schemas/CellularState' + description: 'The details of the cellular state. + + ' + device: + description: 'The device. + + ' + type: string + disabled: + description: 'List the element interfaces in a disabled state. + + ' + type: boolean + disabled_reason: + description: 'List the reason for the disabled state. + + ' + type: string + dns_v4_config: + $ref: '#/components/schemas/DNS' + description: "The DNS V4 configurations. \n" + dns_v6_config: + $ref: '#/components/schemas/DNS' + description: "The DNS V6 configurations. \n" + effective_vlans: + description: 'The number of effective VLANs. + + ' + items: + description: Effective Vlans + type: integer + type: array + element_id: + description: 'The element ID. + + ' + type: string + extended_state: + description: 'The extended state of the interface. + + ' + type: string + id: + description: 'The interface ID. + + ' + type: string + ike_algo: + description: 'The IKE algorithm. (value = true). + + ' + type: string + ike_last_rekeyed: + description: "The last rekeyed IKE. (value = true). \n" + format: int64 + type: integer + ike_next_rekey: + description: 'The next rekey IKE. (value = true). + + ' + format: int64 + type: integer + inactive: + description: 'Lists if the interface state is inactive. + + ' + type: boolean + inactive_reason: + description: 'Reason the interface state is inactive. Max size = 5000. + + ' + type: string + index: + description: 'Index: JsonIgnore(value = true) ' + format: int32 + type: integer + ipsec_algo: + description: 'The IPsec algorithm. (value = true). + + ' + type: string + ipsec_last_rekeyed: + description: "The last rekeyed IPsec. (value = true). \n" + format: int64 + type: integer + ipsec_next_rekey: + description: 'The next IPsec rekey. (value = true). + + ' + format: int64 + type: integer + ipv4_addresses: + description: 'The IPv4 addresses configured for the interface. + + ' + items: + description: Ipv4 Addresses + type: string + type: array + ipv4_addresses_changed: + description: 'If any IPv4 addresses are change. True or False. + + ' + type: boolean + ipv6_addresses: + description: 'The IPv6 addresses configured for the interface. + + ' + items: + description: Ipv6 Addresses + type: string + type: array + ipv6_addresses_changed: + description: 'If any IPv6 addresses are change. True or False. + + ' + type: boolean + last_state_change: + description: "The last state that was changed. \n" + format: int64 + type: integer + link_local_address: + description: "The link local address. \n" + type: string + lldp_enabled: + description: 'Lldp enabled. True or False. + + ' + type: boolean + local_tunnel_v4_addr: + description: 'The local tunnel v4 address. (value = true). + + ' + type: string + mac_address: + description: 'The MAC address. + + ' + type: string + name: + description: 'The name of the interface state. + + ' + type: string + negotiated_mtu: + description: "The negotiated maximum transmission unit. \n" + format: int32 + type: integer + operational_state: + description: "The operational state. True or False.. \n" + type: string + operational_state_changed: + description: 'If any operational state has changed. True or False. + + ' + type: boolean + poe_state: + $ref: '#/components/schemas/PoeStateS' + description: 'The power over ethernet state details. + + ' + port: + $ref: '#/components/schemas/Port' + description: 'The port details. + + ' + region: + description: Region + type: string + remote_host_name: + description: "The remote host name. \n" + type: string + remote_v4_addr: + description: 'The remote v4 address. + + ' + type: string + routes: + description: "The route details. \n" + items: + $ref: '#/components/schemas/Route' + type: array + routes_v6: + description: "The v6 route details. \n" + items: + $ref: '#/components/schemas/Ipv6Route' + type: array + secondary_ipv4_addresses: + description: 'The secondary IPV4 addresses configured. + + ' + items: + description: Secondary Ipv4 Addresses + type: string + type: array + state: + description: 'The state. (value = true). + + ' + type: boolean + stp_state: + $ref: '#/components/schemas/STPStateS' + description: 'The stp state details. + + ' + svi_state: + $ref: '#/components/schemas/SVIStateS' + description: 'The svi state details. + + ' + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + type: string + required: + - tenant_id + InterfaceStateV3N1: + properties: + device: + description: Device + type: string + dns_v4_config: + $ref: '#/components/schemas/DNS' + description: 'Dns V4 Config: Valid ' + dns_v6_config: + $ref: '#/components/schemas/IPv6DNS' + description: Dns V6 Config + element_id: + description: Element Id + type: string + extended_state: + description: Extended State + type: string + id: + description: Id + type: string + ipv4_addresses: + description: Ipv4 Addresses + items: + description: Ipv4 Addresses + type: string + type: array + ipv6_addresses: + description: Ipv6 Addresses + items: + description: Ipv6 Addresses + type: string + type: array + last_state_change: + description: Last State Change + format: int64 + type: integer + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + negotiated_mtu: + description: Negotiated Mtu + format: int32 + type: integer + operational_state: + description: Operational State + type: string + port: + $ref: '#/components/schemas/Port' + description: Port + remote_host_name: + description: Remote Host Name + type: string + remote_v4_addr: + description: Remote V4 Addr + type: string + routes: + description: Routes + items: + $ref: '#/components/schemas/Route' + type: array + service_link: + $ref: '#/components/schemas/ServiceLink' + description: Service Link + InterfaceStateV3N2: + properties: + device: + description: Device + type: string + dns_v4_config: + $ref: '#/components/schemas/DNS' + description: 'Dns V4 Config: Valid ' + dns_v6_config: + $ref: '#/components/schemas/IPv6DNS' + description: Dns V6 Config + element_id: + description: Element Id + type: string + extended_state: + description: Extended State + type: string + id: + description: Id + type: string + ipv4_addresses: + description: Ipv4 Addresses + items: + description: Ipv4 Addresses + type: string + type: array + ipv6_addresses: + description: Ipv6 Addresses + items: + description: Ipv6 Addresses + type: string + type: array + last_state_change: + description: Last State Change + format: int64 + type: integer + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + negotiated_mtu: + description: Negotiated Mtu + format: int32 + type: integer + operational_state: + description: Operational State + type: string + port: + $ref: '#/components/schemas/Port' + description: Port + remote_host_name: + description: Remote Host Name + type: string + remote_v4_addr: + description: Remote V4 Addr + type: string + routes: + description: Routes + items: + $ref: '#/components/schemas/Route' + type: array + secondary_ipv4_addresses: + description: Secondary Ipv4 Addresses + items: + description: Secondary Ipv4 Addresses + type: string + type: array + service_link: + $ref: '#/components/schemas/ServiceLink' + description: Service Link + InterfaceStateV3N3: + properties: + cellular_state: + $ref: '#/components/schemas/CellularState' + description: Cellular State + device: + description: Device + type: string + dns_v4_config: + $ref: '#/components/schemas/DNS' + description: 'Dns V4 Config: Valid ' + dns_v6_config: + $ref: '#/components/schemas/IPv6DNS' + description: Dns V6 Config + element_id: + description: Element Id + type: string + extended_state: + description: Extended State + type: string + id: + description: Id + type: string + ipv4_addresses: + description: Ipv4 Addresses + items: + description: Ipv4 Addresses + type: string + type: array + ipv6_addresses: + description: Ipv6 Addresses + items: + description: Ipv6 Addresses + type: string + type: array + last_state_change: + description: Last State Change + format: int64 + type: integer + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + negotiated_mtu: + description: Negotiated Mtu + format: int32 + type: integer + operational_state: + description: Operational State + type: string + port: + $ref: '#/components/schemas/Port' + description: Port + remote_host_name: + description: Remote Host Name + type: string + remote_v4_addr: + description: Remote V4 Addr + type: string + routes: + description: Routes + items: + $ref: '#/components/schemas/Route' + type: array + secondary_ipv4_addresses: + description: Secondary Ipv4 Addresses + items: + description: Secondary Ipv4 Addresses + type: string + type: array + service_link: + $ref: '#/components/schemas/ServiceLink' + description: Service Link + InterfaceStateV3N4: + properties: + cellular_state: + $ref: '#/components/schemas/CellularState' + description: Cellular State + device: + description: Device + type: string + dns_v4_config: + $ref: '#/components/schemas/DNS' + description: 'Dns V4 Config: Valid ' + dns_v6_config: + $ref: '#/components/schemas/IPv6DNS' + description: Dns V6 Config + element_id: + description: Element Id + type: string + extended_state: + description: Extended State + type: string + id: + description: Id + type: string + ipv4_addresses: + description: Ipv4 Addresses + items: + description: Ipv4 Addresses + type: string + type: array + ipv6_addresses: + description: Ipv6 Addresses + items: + description: Ipv6 Addresses + type: string + type: array + last_state_change: + description: Last State Change + format: int64 + type: integer + link_local_address: + description: Link Local Address + type: string + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + negotiated_mtu: + description: Negotiated Mtu + format: int32 + type: integer + operational_state: + description: Operational State + type: string + port: + $ref: '#/components/schemas/Port' + description: Port + remote_host_name: + description: Remote Host Name + type: string + remote_v4_addr: + description: Remote V4 Addr + type: string + routes: + description: Routes + items: + $ref: '#/components/schemas/Route' + type: array + routes_v6: + description: Routes V6 + items: + $ref: '#/components/schemas/Ipv6Route' + type: array + secondary_ipv4_addresses: + description: Secondary Ipv4 Addresses + items: + description: Secondary Ipv4 Addresses + type: string + type: array + service_link: + $ref: '#/components/schemas/ServiceLink' + description: Service Link + InterfaceStateV3N5: + properties: + cellular_state: + $ref: '#/components/schemas/CellularState' + description: 'The cellular state details. + + ' + device: + description: 'The ION device. + + ' + type: string + dns_v4_config: + $ref: '#/components/schemas/DNS' + description: 'The DNS v4 config details. + + ' + dns_v6_config: + $ref: '#/components/schemas/IPv6DNS' + 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. + + ' + type: string + extended_state: + description: 'The extended state. + + ' + type: string + id: + description: 'The interface ID. + + ' + type: string + ipv4_addresses: + description: "The IPv4 addresses configured for the interface. \n" + items: + description: Ipv4 Addresses + type: string + type: array + ipv6_addresses: + description: "The IPv6 addresses configured for the interface. \n" + items: + description: Ipv6 Addresses + type: string + type: array + last_state_change: + description: 'The last state change of the device. + + ' + format: int64 + type: integer + 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. + + ' + type: string + name: + description: 'The name of the interface state. Max size = 128. + + ' + type: string + negotiated_mtu: + description: 'The negotiated IP MTU value. + + ' + format: int32 + type: integer + operational_state: + description: 'The operational state. + + ' + type: string + poe_state: + $ref: '#/components/schemas/PoeStateS' + description: Poe State + port: + $ref: '#/components/schemas/Port' + description: 'The start and end port details. + + ' + remote_host_name: + description: 'The remote host name. + + ' + type: string + remote_v4_addr: + description: 'The remote IPv4 address. + + ' + type: string + routes: + description: "The routing details. \n" + items: + $ref: '#/components/schemas/Route' + type: array + routes_v6: + description: 'The route v6 details. + + ' + items: + $ref: '#/components/schemas/Ipv6Route' + type: array + secondary_ipv4_addresses: + description: 'The secondary IPv4 addresses. + + ' + items: + description: Secondary Ipv4 Addresses + type: string + type: array + service_link: + $ref: '#/components/schemas/ServiceLink' + description: 'The service link details ServiceLink. + + ' + stp_state: + $ref: '#/components/schemas/STPStateS' + description: 'The STP state details. + + ' + svi_state: + $ref: '#/components/schemas/SVIStateS' + description: 'The svi details. + + ' + InterfaceV4N1: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. + + ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: 'The bound interfaces. + + ' + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPair' + description: 'The details of the bypass pair. + + ' + description: + description: 'The interface description. Max size = 256. + + ' + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. + + ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. + + ' + id: + description: 'The interface ID. + + ' + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. + + ' + mac_address: + description: 'The interface configuration MAC address. + + ' + type: string + mtu: + description: 'The MTU value of the interface. + + ' + type: integer + name: + description: 'The name of the interface state. Max size = 128. + + ' + type: string + nat_address: + description: 'The NAT IP address. + + ' + type: string + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. + + ' + format: int32 + type: integer + network_context_id: + description: 'The network context ID. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'The PPPoE config information. + + ' + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. + + ' + type: + description: 'The interface type. + + ' + type: string + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. + + ' + type: string + required: + - used_for + - type + InterfaceV4N10: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. + + ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: 'The bound interfaces. + + ' + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: 'The details of the bypass pair. + + ' + description: + description: 'The interface description. Max size = 256. + + ' + devicemgmt_policysetstack_id: + description: 'The device management policy set stack ID. + + ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. + + ' + directed_broadcast: + description: 'The directed broadcast. + + ' + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. + + ' + id: + description: 'The interface ID. + + ' + type: string + ipfixcollectorcontext_id: + description: 'The IPFIX collector context ID. + + ' + type: string + ipfixfiltercontext_id: + description: 'The IPFIX filter context ID. + + ' + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. + + ' + mac_address: + description: 'The interface configuration MAC address. + + ' + type: string + mtu: + description: 'The MTU value of the interface. + + ' + type: integer + name: + description: 'The name of the interface state. Max size = 128. + + ' + type: string + nat_address: + description: 'The NAT IP address. + + ' + type: string + nat_pools: + description: 'The NAT pools information. + + ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. + + ' + format: int32 + type: integer + nat_zone_id: + description: 'The NAT zone ID. + + ' + type: string + network_context_id: + description: 'The network context ID. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'The PPPoE config information. + + ' + scope: + description: 'The network scope. + + ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'The static ARP config details. + + ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. + + ' + tags: + description: 'A information field that can be added to identify the interface. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The interface type. + + ' + type: string + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. + + ' + type: string + InterfaceV4N11: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. + + ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: 'The bound interfaces. + + ' + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: 'The details of the bypass pair. + + ' + cellular_config: + $ref: '#/components/schemas/CellularInterfaceConfig' + description: 'Cellular Config: Valid ' + description: + description: 'The interface description. Max size = 256. + + ' + devicemgmt_policysetstack_id: + description: 'The device management policy set stack ID. + + ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. + + ' + directed_broadcast: + description: 'The directed broadcast. + + ' + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. + + ' + id: + description: 'The interface ID. + + ' + type: string + ipfixcollectorcontext_id: + description: 'The IPFIX collector context ID. + + ' + type: string + ipfixfiltercontext_id: + description: 'The IPFIX filter context ID. + + ' + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. + + ' + mac_address: + description: 'The interface configuration MAC address. + + ' + type: string + mtu: + description: 'The MTU value of the interface. + + ' + type: integer + multicast_config: + $ref: '#/components/schemas/MulticastInterfaceConfig' + description: 'Multicast Config: Valid ' + name: + description: 'The name of the interface state. Max size = 128. + + ' + type: string + nat_address: + description: 'The NAT IP address. + + ' + type: string + nat_pools: + description: 'The NAT pools information. + + ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. + + ' + format: int32 + type: integer + nat_zone_id: + description: 'The NAT zone ID. + + ' + type: string + network_context_id: + description: 'The network context ID. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'The PPPoE config information. + + ' + scope: + description: 'The network scope. + + ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'The static ARP config details. + + ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. + + ' + tags: + description: 'A information field that can be added to identify the interface. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The interface type. + + ' + type: string + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. + + ' + type: string + required: + - scope + - used_for + - type + InterfaceV4N12: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. + + ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: 'The bound interfaces. + + ' + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: 'The details of the bypass pair. + + ' + cellular_config: + $ref: '#/components/schemas/CellularInterfaceConfig' + description: 'Cellular Config: Valid ' + description: + description: 'The interface description. Max size = 256. + + ' + devicemgmt_policysetstack_id: + description: 'The device management policy set stack ID. + + ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. + + ' + directed_broadcast: + description: 'The directed broadcast. + + ' + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. + + ' + id: + description: 'The interface ID. + + ' + type: string + ipfixcollectorcontext_id: + description: 'The IPFIX collector context ID. + + ' + type: string + ipfixfiltercontext_id: + description: 'The IPFIX filter context ID. + + ' + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. + + ' + ipv6_config: + $ref: '#/components/schemas/Ipv6Config' + description: 'Ipv6 Config: Valid Valid ' + mac_address: + description: 'The interface configuration MAC address. + + ' + type: string + mtu: + description: 'The MTU value of the interface. + + ' + type: integer + multicast_config: + $ref: '#/components/schemas/MulticastInterfaceConfig' + description: 'Multicast Config: Valid ' + name: + description: 'The name of the interface state. Max size = 128. + + ' + type: string + nat_address: + description: 'The NAT IP address. + + ' + 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) ' + type: string + nat_pools: + description: 'The NAT pools information. + + ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. + + ' + format: int32 + type: integer + nat_port_v6: + description: 'Nat Port V6: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'The NAT zone ID. + + ' + type: string + network_context_id: + description: 'The network context ID. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'The PPPoE config information. + + ' + scope: + description: 'The network scope. + + ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'The static ARP config details. + + ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. + + ' + tags: + description: 'A information field that can be added to identify the interface. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The interface type. + + ' + type: string + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. + + ' + type: string + required: + - scope + - used_for + - type + InterfaceV4N13: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. + + ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + authentication_config: + $ref: '#/components/schemas/AuthenticationConfig' + description: 'Authentication Config: Valid ' + bound_interfaces: + description: 'The bound interfaces. + + ' + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: 'The details of the bypass pair. + + ' + cellular_config: + $ref: '#/components/schemas/CellularInterfaceConfig' + description: 'Cellular Config: Valid ' + description: + description: 'The interface description. Max size = 256. + + ' + devicemgmt_policysetstack_id: + description: 'The device management policy set stack ID. + + ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. + + ' + directed_broadcast: + description: 'The directed broadcast. + + ' + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. + + ' + id: + description: 'The interface ID. + + ' + type: string + interface_profile_id: + description: Interface Profile Id + type: string + ipfixcollectorcontext_id: + description: 'The IPFIX collector context ID. + + ' + type: string + ipfixfiltercontext_id: + description: 'The IPFIX filter context ID. + + ' + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. + + ' + ipv6_config: + $ref: '#/components/schemas/Ipv6Config' + description: 'The ipv6 config information. + + ' + lldp_enabled: + description: 'If LLDP enabled. True/False. + + ' + type: boolean + mac_address: + description: 'The interface configuration MAC address. + + ' + type: string + mtu: + description: 'The MTU value of the interface. + + ' + type: integer + multicast_config: + $ref: '#/components/schemas/MulticastInterfaceConfig' + description: 'The multicast config details. + + ' + name: + description: 'The name of the interface state. Max size = 128. + + ' + type: string + nat_address: + description: 'The NAT IP address. + + ' + 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) ' + type: string + nat_pools: + description: 'The NAT pools information. + + ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. + + ' + format: int32 + type: integer + nat_port_v6: + description: "The NAT IPv6 port.Internet bypass ports cannot be part of\ + \ logical interface groups. \n" + format: int32 + type: integer + nat_zone_id: + description: 'The NAT zone ID. + + ' + type: string + network_context_id: + description: 'The network context ID. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + poe_enabled: + description: 'PoE enabled = true/false. + + ' + type: boolean + power_usage_threshold: + description: 'The interface config PoE power usage threshold. Valid values + are in the range 50-100. + + ' + format: int32 + type: integer + pppoe_config: + $ref: '#/components/schemas/PppoEInterfaceConfig' + description: 'The PPPoE config information. + + ' + scope: + description: 'The network scope. + + ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'The static ARP config details. + + ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. + + ' + switch_port_config: + $ref: '#/components/schemas/SwitchPortConfig' + description: 'The switch port config details. + + ' + tags: + description: 'A information field that can be added to identify the interface. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The interface type. + + ' + type: string + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. + + ' + type: string + vlan_config: + $ref: '#/components/schemas/VlanConfig' + description: 'The VLAN config details. + + ' + required: + - scope + - used_for + - type + InterfaceV4N14: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + authentication_config: + $ref: '#/components/schemas/AuthenticationConfig' + description: 'Authentication Config: Valid ' + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + cellular_config: + $ref: '#/components/schemas/CellularInterfaceConfig' + description: 'Cellular Config: Valid ' + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + directed_broadcast: + description: Directed Broadcast + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + interface_profile_id: + description: Interface Profile Id + type: string + ipfixcollectorcontext_id: + description: Ipfixcollectorcontext Id + type: string + ipfixfiltercontext_id: + description: Ipfixfiltercontext Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + ipv6_config: + $ref: '#/components/schemas/Ipv6Config' + description: 'Ipv6 Config: Valid Valid ' + lldp_enabled: + description: Lldp Enabled + type: boolean + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + multicast_config: + $ref: '#/components/schemas/MulticastInterfaceConfig' + description: 'Multicast Config: Valid ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + 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) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_port_v6: + description: 'Nat Port V6: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + poe_enabled: + description: Poe Enabled + type: boolean + power_usage_threshold: + description: 'Power Usage Threshold: ValidateDecimal(allowZero = true, increment + = 0, max = 0, error = INTERFACE_CONFIG_INVALID_POE_POWER_USAGE_THRESHOLD: + Invalid Interface configuration. Invalid PoE alarm threshold value {}. + Valid values are in the range 50-100., min = 0) ' + format: int32 + type: integer + pppoe_config: + $ref: '#/components/schemas/PppoEInterfaceConfig' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'Secondary Ip Configs: Size(max = 8, error = INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT: + Invalid interface configuration. Secondary IPs exceed the supported limit + of 8, min = 0) ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'Static Arp Configs: Size(max = 32, error = INTERFACE_CONFIG_STATIC_ARP_EXCEEDS_LIMIT: + Invalid interface configuration. Static ARP entries exceed the supported + limit of 16, min = 0) ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + switch_port_config: + $ref: '#/components/schemas/SwitchPortConfig' + description: 'Switch Port Config: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + vlan_config: + $ref: '#/components/schemas/VlanConfig' + description: 'Vlan Config: Valid ' + required: + - scope + - used_for + - type + InterfaceV4N2: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - used_for + - type + InterfaceV4N3: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - used_for + - type + InterfaceV4N4: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceV4N5: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceV4N6: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceV4N7: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceV4N8: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceV4N9: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + directed_broadcast: + description: Directed Broadcast + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InventoryOperation: + enum: + - claim + - return + - revoke + - reuse + - retire + - recover + - remanufacture + - default + - invalid + - esp_allocate + - esp_received_stock + - esp_return + - esp_revoke + - esp_reuse + type: string + Ipv4Config: + properties: + dhcp_config: + $ref: '#/components/schemas/Ipv4Dhcp' + description: 'The DHCP config information. + + ' + dns_v4_config: + $ref: '#/components/schemas/DNS' + description: 'The DNS v4 config details. + + ' + pppoe_config: + $ref: '#/components/schemas/Ipv4Pppoe' + description: 'The PPoE config information. + + ' + routes: + description: 'The ethernet port routes. + + ' + items: + $ref: '#/components/schemas/Route' + type: array + static_config: + $ref: '#/components/schemas/Ipv4Static' + description: 'The IPv4 static address. + + ' + type: + description: 'The interface config type. Max = 12. + + ' + type: string + Ipv4Dhcp: + properties: + client_id: + description: 'The client ID. + + ' + type: string + hostname: + description: 'The IPv4 DHCP host name. + + ' + type: string + Ipv4Pppoe: + properties: + chap_passwd: + description: 'The PPPoE IPv4 CHAP password. + + ' + type: string + chap_user: + description: 'The PPPoE IPv4 CHAP user. + + ' + type: string + set_route: + description: "The set route for PPPoE IPv4. \n" + type: boolean + Ipv4Static: + properties: + 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 + Ipv6Dhcp: + properties: + client_id: + description: 'The client ID. + + ' + type: string + hostname: + description: 'The IPv6 DHCP host name. + + ' + type: string + Ipv6Route: + properties: + destination: + description: 'The route destination. + + ' + type: string + via: + description: 'The via IPv6 address. + + ' + type: string + Ipv6Static: + properties: + address: + description: Address + type: string + LanNetworkVlanMapping: + properties: + lan_network_id: + description: 'The LAN network ID. + + ' + type: string + vlan_id: + description: 'The VLAN ID. VLAN ID should be between 0 and 4095. + + ' + format: int32 + type: integer + LedConfig: + properties: + service_led_on: + description: Service Led On + type: boolean + 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 + Machine: + properties: + connected: + description: "The device is connected. True or False. \n" + type: boolean + console_conf_passphrase: + description: "The console password. \n" + type: string + em_element_id: + description: "The element ID. \n" + type: string + hw_id: + description: 'The hardware ID. + + ' + type: string + id: + description: Id + type: string + image_version: + description: 'The image version. + + ' + type: string + inventory_op: + 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 + is_eval: + description: Is Eval + type: boolean + machine_state: + 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 + type: string + manufacture_id: + description: 'The manufacture ID. + + ' + type: string + model_name: + description: "The model name of the device. \n" + type: string + ordering_info: + description: "The order information. \n" + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + description: Pki Op + renew_state: + 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 + type: string + ship_state: + 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 + required: + - ship_state + - manufacture_id + - renew_state + - machine_state + - image_version + - model_name + - sl_no + - hw_id + - tenant_id + MachineInfo: + properties: + connected: + description: "The device is connected. True or False. \n" + type: boolean + console_conf_passphrase: + description: "The console password. \n" + type: string + 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: + type: string + image_version: + description: 'The image version. + + ' + type: string + inventory_op: + $ref: '#/components/schemas/InventoryOperation' + description: 'The inventory lifecycle values. + + ' + machine_state: + $ref: '#/components/schemas/MachineState' + description: 'The various device states. + + ' + manufacture_id: + description: 'The manufacture ID. + + ' + type: string + model_name: + description: "The model name of the device. \n" + type: string + ordering_info: + description: "The order information. \n" + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + renew_state: + $ref: '#/components/schemas/MachineState' + description: 'The device renew states. + + ' + ship_state: + $ref: '#/components/schemas/MachineShipState' + description: 'The shipping status. + + ' + sl_no: + description: 'The serial number. + + ' + type: string + tenant_id: + type: string + token: + description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. + + ' + type: string + type: object + MachineInfoV2N2: + properties: + connected: + type: boolean + console_conf_passphrase: + type: string + em_element_id: + type: string + esp_tenant_id: + type: string + hw_id: + type: string + id: + type: string + image_version: + type: string + inventory_op: + $ref: '#/components/schemas/InventoryOperation' + machine_state: + $ref: '#/components/schemas/MachineState' + manufacture_id: + type: string + model_name: + type: string + ordering_info: + type: string + owner_tenant_id: + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + renew_state: + $ref: '#/components/schemas/MachineState' + ship_state: + $ref: '#/components/schemas/MachineShipState' + sl_no: + type: string + tenant_id: + type: string + token: + type: string + type: object + MachineInfoV2N3: + properties: + connected: + description: "The device is connected. True or False. \n" + type: boolean + console_conf_passphrase: + description: "The console password. \n" + type: string + em_element_id: + description: "The element ID. \n" + type: string + esp_tenant_id: + description: 'The MSP tenant ID. + + ' + type: string + hw_id: + description: 'The hardware ID. + + ' + type: string + id: + type: string + image_version: + description: 'The image version. + + ' + type: string + inventory_op: + $ref: '#/components/schemas/InventoryOperation' + description: 'The inventory lifecycle values. + + ' + machine_state: + $ref: '#/components/schemas/MachineState' + description: 'The various device states. + + ' + manufacture_id: + description: 'The manufacture ID. + + ' + type: string + model_name: + description: "The model name of the device. \n" + type: string + ordering_info: + description: "The order information. \n" + type: string + owner_tenant_id: + description: "The owner tenant ID. \n" + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + renew_state: + $ref: '#/components/schemas/MachineState' + description: 'The device renew states. + + ' + sales_order_number: + description: 'The sales order number. + + ' + type: string + ship_state: + $ref: '#/components/schemas/MachineShipState' + description: 'The shipping status. + + ' + sl_no: + 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 + MachineQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of machines that match the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number machines deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the machines for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the machines 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 + MachineQueryFilterV2N1: + properties: + connected: + description: "The device is connected. True or False. \n" + type: boolean + console_conf_passphrase: + description: "The console password. \n" + type: string + 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. + + ' + type: string + inventory_op: + 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 + is_eval: + description: Is Eval + type: boolean + machine_state: + 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 + type: string + manufacture_id: + description: 'The manufacture ID. + + ' + type: string + model_name: + description: "The model name of the device. \n" + type: string + ordering_info: + description: "The order information. \n" + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + description: Pki Op + renew_state: + 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 + type: string + ship_state: + 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 + suspend_state: + description: 'The suspend 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 + type: string + tenant_id: + description: Tenant Id + type: string + token: + description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. + + ' + type: string + MachineQueryFilterV2N2: + properties: + connected: + description: Connected + type: boolean + console_conf_passphrase: + description: Console Conf Passphrase + type: string + em_element_id: + description: Em Element Id + type: string + esp_tenant_id: + description: 'Esp Tenant Id: JsonInclude(content = ALWAYS, contentFilter + = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' + type: string + hw_id: + description: Hardware Id + type: string + id: + description: Id + type: string + image_version: + description: Image Version + type: string + inventory_op: + description: Inventory Op + 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 + is_eval: + description: Is Eval + type: boolean + machine_state: + description: Machine State + 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 + type: string + manufacture_id: + description: Manufacture Id + type: string + model_name: + description: Model Name + type: string + ordering_info: + description: Ordering Info + type: string + owner_tenant_id: + description: 'Owner Tenant Id: JsonInclude(content = ALWAYS, contentFilter + = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + description: Pki Op + renew_state: + description: Renew State + 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 + type: string + ship_state: + description: Ship State + enum: + - MACHINE_SHIPPED + - MACHINE_SHIPPED_CORRECT_ADDRESS + - MACHINE_SHIPPED_WRONG_ADDRESS + - MACHINE_NOT_SHIPPED + type: string + sl_no: + description: Sl No + type: string + suspend_state: + description: Suspend State + 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 + type: string + tenant_id: + description: Tenant Id + type: string + token: + description: Token + type: string + MachineQueryFilterV2N3: + properties: + connected: + description: "The device is connected. True or False. \n" + type: boolean + console_conf_passphrase: + description: "The console password. \n" + type: string + em_element_id: + description: "The element ID. \n" + type: string + esp_tenant_id: + description: 'The MSP tenant ID. + + ' + type: string + hw_id: + description: 'The hardware ID. + + ' + type: string + id: + description: Id + type: string + image_version: + description: 'The image version. + + ' + type: string + inventory_op: + 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 + is_eval: + description: Is Eval + type: boolean + machine_state: + 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 + type: string + manufacture_id: + description: 'The manufacture ID. + + The manufacture ID. + + ' + type: string + model_name: + description: "The model name of the device. \n" + type: string + ordering_info: + description: "The order information. \n" + type: string + owner_tenant_id: + description: "The owner tenant ID. \n" + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + description: Pki Op + renew_state: + 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 + type: string + sales_order_number: + description: 'The sales order number. + + ' + type: string + ship_state: + description: 'The shipping status. + + ' + enum: + - MACHINE_SHIPPED + - MACHINE_SHIPPED_CORRECT_ADDRESS + - MACHINE_SHIPPED_WRONG_ADDRESS + - MACHINE_NOT_SHIPPED + type: string + sl_no: + description: Sl No + type: string + suspend_state: + description: 'The suspend state. + + ' + 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 + type: string + tenant_id: + description: 'The tenant ID. + + ' + type: string + token: + description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. + + ' + type: string + MachineShipState: + enum: + - machine_shipped + - machine_shipped_correct_address + - machine_shipped_wrong_address + - machine_not_shipped + type: string + MachineState: + enum: + - manufactured + - manufactured_qa_pending + - manufactured_qa_ok + - manufactured_qa_not_ok + - manufactured_battery_test_pending + - manufactured_battery_test_start + - manufactured_battery_test_passed + - 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 + - allocated + - allocated_to_esp + - claim_pending + - initializing + - initialization_failed + - assigned + - claim_pending + - claimed + - claim_failed + - to_be_returned + - returned + - revoked + - machine_element_delete_pending + - return_failed + - received_stock + - remanufactured + - retired + - recover + - 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 + type: string + MachineSystemStatusV2N1: + properties: + boot_mode: + description: "The possible values in the boot mode. \n" + enum: + - BIOS + - UEFI_ONLY + - UEFI_SECURE + type: string + disk_status: + description: "The status details of the disk. \n" + items: + $ref: '#/components/schemas/DiskPartitionStatus' + type: array + fips_mode: + description: "The possible values in the FIPs. \n" + enum: + - none + - fips + - non_fips + type: string + hardware_id: + description: "The machine hardware ID. \n" + type: string + id: + description: 'The machine ID. + + ' + type: string + tpm_status: + description: 'The TPM status. + + ' + type: string + trusted_boot: + description: 'The possible values in trusted boot. + + ' + enum: + - PASSED + - FAILED + type: string + required: + - hardware_id + MachineV2N1: + properties: + connected: + description: "The device is connected. True or False. \n" + type: boolean + console_conf_passphrase: + description: "The console password. \n" + type: string + 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. + + ' + type: string + inventory_op: + 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 + is_eval: + description: Is Eval + type: boolean + machine_state: + 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 + type: string + manufacture_id: + description: 'The manufacture ID. + + ' + type: string + model_name: + description: "The model name of the device. \n" + type: string + ordering_info: + description: "The order information. \n" + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + description: Pki Op + renew_state: + 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 + type: string + ship_state: + 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 + suspend_state: + description: 'The suspend 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 + type: string + tenant_id: + description: Tenant Id + type: string + token: + description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. + + ' + type: string + MachineV2N2: + properties: + connected: + description: "The device is connected. True or False. \n" + type: boolean + console_conf_passphrase: + description: "The console password. \n" + type: string + em_element_id: + description: "The element ID. \n" + type: string + esp_tenant_id: + description: 'The MSP tenant ID. + + ' + type: string + hw_id: + description: 'The hardware ID. + + ' + type: string + id: + description: Id + type: string + image_version: + description: 'The image version. + + ' + type: string + inventory_op: + 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 + is_eval: + description: Is Eval + type: boolean + machine_state: + 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 + type: string + manufacture_id: + description: 'The manufacture ID. + + ' + type: string + model_name: + description: "The model name of the device. \n" + type: string + ordering_info: + description: "The order information. \n" + type: string + owner_tenant_id: + description: "The owner tenant ID. \n" + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + description: Pki Op + renew_state: + 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 + type: string + ship_state: + description: 'The shipping status. + + ' + enum: + - MACHINE_SHIPPED + - MACHINE_SHIPPED_CORRECT_ADDRESS + - MACHINE_SHIPPED_WRONG_ADDRESS + - MACHINE_NOT_SHIPPED + type: string + sl_no: + description: Sl No + type: string + suspend_state: + description: 'The suspend state. + + ' + 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 + type: string + tenant_id: + description: Tenant Id + type: string + token: + description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. + + ' + type: string + MachineV2N3: + properties: + connected: + description: "The device is connected. True or False. \n" + type: boolean + console_conf_passphrase: + description: "The console password. \n" + type: string + em_element_id: + description: "The element ID. \n" + type: string + esp_tenant_id: + description: 'The MSP tenant ID. + + ' + type: string + hw_id: + description: 'The hardware ID. + + ' + type: string + id: + description: Id + type: string + image_version: + description: 'The image version. + + ' + type: string + inventory_op: + 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 + is_eval: + description: Is Eval + type: boolean + machine_state: + 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 + type: string + manufacture_id: + description: 'The manufacture ID. + + ' + type: string + model_name: + description: "The model name of the device. \n" + type: string + ordering_info: + description: "The order information. \n" + type: string + owner_tenant_id: + description: "The owner tenant ID. \n" + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + description: Pki Op + renew_state: + 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 + type: string + sales_order_number: + description: 'The sales order number. + + ' + type: string + ship_state: + 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 + suspend_state: + description: 'The suspend state. + + ' + 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 + type: string + tenant_id: + 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: + description: 'The IGMP version. + + ' + enum: + - IGMPV2 + - IGMPV3 + type: string + multicast_enabled: + description: 'Is multicast enabled. True or False. + + ' + type: boolean + NatPool: + properties: + ipv4_ranges: + description: 'The NAT Ipv4 address ranges. Minimum 1 and maximum 4 nat pool + IP ranges can be specified. + + ' + items: + $ref: '#/components/schemas/IPv4Range' + type: array + nat_pool_id: + description: 'The NAT pool ID. + + ' + type: string + PeerInfo: + properties: + hostname: + description: 'The peer hostname. + + ' + type: string + ip_addresses: + description: 'The peer IP addresses. Max size = 4. + + ' + items: + description: Ip Addresses + type: string + type: array + PoeStateS: + properties: + detection_status: + description: 'The PoE detection status. + + ' + type: string + device_type: + description: 'The ION device type. + + ' + type: string + operational_state: + description: "The PoE operational state. \n" + type: string + poe_enabled: + description: "Indicates if PoE is enabled. By default, PoE is disabled.\ + \ \n" + type: boolean + power_classification: + description: "The power classification. \n" + type: string + power_consumed: + description: 'The power consumed. + + ' + format: float + type: number + power_pairs_control_ability: + description: 'Values = True or False. + + ' + type: boolean + power_pairs_state: + description: 'The power pair state. + + ' + type: string + power_priority: + description: 'The power priority. + + ' + type: string + power_usage_threshold: + description: 'The Port Power Usage Alarm Threshold value is between 50 - + 100%.The default threshold is 100% (60W). + + ' + format: int32 + type: integer + Port: + properties: + end: + description: 'The end port range must be between 1 and 65535. + + ' + type: string + start: + description: 'The start port range must be between 1 and 65535. + + ' + type: string + PppoE: + properties: + host_uniq: + description: 'The PPPoE host unique length. It can be null or minimum length + of 2 to maximum length of 254. Length should be in multiples of 2. + + ' + type: string + ip_address_type: + description: 'The PPPoE IP address type. + + ' + enum: + - ipv4 + - ipv6 + - ipv4v6 + type: string + parent: + description: 'The parent value = true. + + ' + type: string + password: + description: 'The PPPoE password. Password is required and can have a max + length of 128 characters. + + ' + type: string + reconnection_delay: + description: 'The reconnection delay time. + + ' + format: int32 + type: integer + service_name: + description: 'The service name. + + ' + type: string + username: + description: 'The PPPoE user name. Username is required and can have a max + length of 128 characters. + + ' + type: string + required: + - ip_address_type + PppoEInterfaceConfig: + properties: + host_uniq: + description: 'The host. + + ' + type: string + ip_address_type: + description: 'IPv4 and IPv6 addresses. + + ' + type: string + password: + description: 'The password for the PPOE interface configuration. + + ' + type: string + reconnection_delay: + description: 'The recoonection delay value. + + ' + format: int32 + type: integer + service_name: + description: 'The name of the service used for the PPPoE configuration. + + ' + type: string + username: + description: 'The username for the PPPoE interface configuration. + + ' + type: string + RecoveryToken: + properties: + hardware_id: + description: Hardware Id + type: string + id: + description: Id + type: string + ion_token: + description: Ion Token + type: string + is_used: + description: Is Used + type: boolean + secret_token: + description: Secret Token + type: string + token_validity_in_hour: + description: Token Validity In Hour + format: int32 + type: integer + valid_till_secs: + description: Valid Till Secs + format: int64 + type: integer + RecoveryTokenScreen: + properties: + id: + description: 'The recovery token ID. + + ' + type: string + token_validity_in_hour: + description: 'The token validity in a hour. + + ' + format: int32 + type: integer + Route: + properties: + destination: + description: 'The route destination. + + ' + type: string + via: + description: 'The via IP address. + + ' + type: string + STPStateS: + properties: + bpdu_guard_enabled: + description: 'BPDU Guard enabled on ports do not receive a BPDU from its + connected devices. When a BPDU Guard enabled port receives BPDU from a + connected device, BPDU Guard disables the port. + + ' + type: boolean + forward_fast_enabled: + description: 'The speed. + + ' + type: boolean + mstp_instance_id: + description: "The MSTP instance ID. \n" + format: int32 + type: integer + port_cost: + description: "The STP port cost is between 1-65535. The STP port cost depends\ + \ on the speed of the port. \n" + format: int32 + type: integer + port_priority: + description: "The STP Port priority is between 0-240. The default value\ + \ is 128, STP port priority is in multiples of 16. \n" + format: int32 + type: integer + port_state: + description: 'The port state. + + ' + type: string + root_guard_enabled: + description: 'Root Guard is enabled on a port-by-port basis, it prevents + a configured port from becoming a root port. Root Guard prevents a downstream + switch from becoming a root bridge in a topology. + + ' + type: boolean + stp_enabled: + description: 'Spanning Tree Protocol (STP) is enabled by default. By default, + the STP type is RSTP. + + ' + type: boolean + SVIStateS: + properties: + stp_designated_cost: + description: "The STP designated cost between 1-65535. \n" + type: integer + stp_designated_mac_address: + description: "The STP designated MAC address. \n" + type: string + stp_designated_port: + description: "The STP designated port. \n" + type: integer + stp_designated_root_mac_address: + description: 'The STP designated root MAC address. + + ' + type: string + SecondaryIPConfig: + properties: + ipv4_address: + description: Ipv4 Address + type: string + scope: + description: "The scope of the secondary IP config. \n" + type: string + ServiceLink: + properties: + gre_config: + $ref: '#/components/schemas/GREConfig' + description: 'The GRE config details. + + ' + ipsec_config: + $ref: '#/components/schemas/IPSECConfig' + description: 'The IPSec config details. + + ' + last_parent: + description: 'The last parent value = true. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + peer: + $ref: '#/components/schemas/PeerInfo' + description: 'The peer information. + + ' + security_service_endpoint_id: + description: 'The security service endpoint ID. + + ' + type: string + service_endpoint_id: + description: 'The service endpoint ID. + + ' + type: string + type: + description: 'The service link type. + + ' + enum: + - IPSEC + - GRE + type: string + required: + - type + ServiceLinkV1: + properties: + ipsec_config: + $ref: '#/components/schemas/IPSECConfig' + description: 'Ipsec Config: Valid ' + last_parent: + description: 'Last Parent: JsonIgnore(value = true) ' + type: string + parent: + description: 'Parent: JsonIgnore(value = true) ' + type: string + peer: + $ref: '#/components/schemas/PeerInfo' + description: 'Peer: Valid ' + service_endpoint_id: + description: Service Endpoint Id + type: string + type: + description: 'Type: ValidateEnum(enumClass = classOf[ServiceLinkType], INVALID_SERVICE_LINK_TYPE, + nullAllowed = false) ' + enum: + - IPSEC + - GRE + type: string + required: + - type + ServiceLinkV2: + properties: + gre_config: + $ref: '#/components/schemas/GREConfig' + description: 'The GRE config details. + + ' + ipsec_config: + $ref: '#/components/schemas/IPSECConfig' + description: 'The IPSec config details. + + ' + last_parent: + description: 'The last parent value = true. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + peer: + $ref: '#/components/schemas/PeerInfo' + description: 'The peer information. + + ' + service_endpoint_id: + description: "The service endpoint ID. \n" + type: string + type: + description: 'The service link type. + + ' + enum: + - IPSEC + - GRE + type: string + required: + - type + Software: + properties: + location: + description: Location + type: string + version: + description: Version + type: string + SpokeHAConfigV1: + properties: + cluster_id: + description: 'Cluster Id: Required(SPOKEHA_CONFIG_CLUSTER_ID_REQD) ' + type: string + enable: + description: 'Enable: Required(SPOKEHA_CONFIG_ENABLE_REQD) ' + type: boolean + priority: + description: 'Priority: Required(SPOKEHA_CONFIG_PRIORITY_REQD) Range(max + = 254L, SPOKEHA_CONFIG_INVALID_PRIORITY, min = 1L) ' + format: int32 + type: integer + source_interface: + description: 'Source Interface: Required(SPOKEHA_CONFIG_SOURCE_INTERFACE_ID_REQD) ' + type: string + track: + $ref: '#/components/schemas/TrackV1' + description: 'Track: Valid ' + required: + - source_interface + - priority + - enable + - cluster_id + SpokeHAConfigV2: + properties: + cluster_id: + description: "The spoke HA config cluster ID. \n" + type: string + enable: + description: "The spoke HA config enabled. True or False. \n" + type: boolean + priority: + description: "The priority of the spoke HA config. \n" + format: int32 + type: integer + source_interface: + description: 'The spoke HA config source interface ID. + + ' + type: string + track: + $ref: '#/components/schemas/TrackV2' + description: 'Track: Valid ' + required: + - source_interface + - priority + - enable + - cluster_id + StaticARPConfig: + properties: + ipv4_address: + description: 'The static APR IPv4 address. + + ' + type: string + mac_address: + description: 'The MAC address. + + ' + type: string + StormControlConfig: + properties: + broadcast_threshold: + description: 'By default, the broadcast threshold is set to 1000kbps. Enter + a value between 64 -1000000 kbps. + + ' + type: integer + multicast_threshold: + description: 'Multicast threshold value is set between 64-1000000kbps. + + ' + type: integer + unicast_threshold: + description: 'Unknown Unicast threshold value is set between 64-1000000 + kbps. + + ' + type: integer + SubInterface: + properties: + vlan_id: + description: Vlan Id + format: int32 + type: integer + 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 + SwitchConfig: + properties: + default_vlan_id: + description: 'Default VLAN ID is 1. + + ' + format: int32 + type: integer + mstp_enabled: + description: 'The MSTP enabled. True or False. + + ' + type: boolean + stp_aging_timer: + description: "The STP aging Timer between 10 - 1000000 seconds. \ + \ \n" + format: int32 + type: integer + 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: "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: '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: 'The STP Mode is RSTP, default STP mode is RSTP + + ' + enum: + - RSTP + type: string + stp_priority: + description: 'The Priority value is between 0 - 61440, in multiples of 4096. + + ' + format: int32 + type: integer + required: + - stp_mode + SwitchPortConfig: + properties: + access_vlan_id: + description: 'The VLAN access ID. + + ' + type: integer + bpdu_guard_enabled: + description: 'BPDU Guard enabled on ports do not receive a BPDU from its + connected devices. When a BPDU Guard enabled port receives BPDU from a + connected device, BPDU Guard disables the port. + + ' + type: boolean + forward_fast_enabled: + description: 'The speed. + + The attached lan network ID and vlan ID. + + ' + type: boolean + native_vlan_id: + description: 'The VLAN ID. + + ' + type: integer + root_guard_enabled: + description: 'Root Guard is enabled on a port-by-port basis, it prevents + a configured port from becoming a root port. Root Guard prevents a downstream + switch from becoming a root bridge in a topology. + + ' + type: boolean + storm_control_config: + $ref: '#/components/schemas/StormControlConfig' + description: 'Storm control config information. Threshold for traffic rate + limit, the traffic is rate limited for the set threshold value. + + ' + stp_port_cost: + description: 'STP port cost between 1-65535. The STP port cost depends on + the speed of the port. + + ' + format: int32 + type: integer + stp_port_enabled: + description: 'Spanning Tree Protocol (STP) port enabled. + + ' + type: boolean + stp_port_priority: + description: 'STP Port priority is between 0-240. The default value is 128, + STP port priority is in multiples of 16. + + ' + format: int32 + type: integer + trunk_vlans: + description: 'The interface config switch port trunk VLANs. Max trunk VLANs + allowed is 32 and no duplicates are allowed. + + ' + items: + description: Trunk Vlans + type: string + type: array + vlan_mode: + description: 'The VLAN mode. + + ' + enum: + - access + - trunk + type: string + voice_vlan_id: + description: 'The voice VLAN ID. + + ' + type: integer + required: + - vlan_mode + SwitchState: + properties: + bridge_id: + description: 'The switch bridge ID + + ' + type: string + default_vlan_id: + description: 'Default VLAN ID is 1. + + ' + format: int32 + type: integer + designated_bridge_id: + description: "The designated bridge ID. \n" + type: string + last_topology_change: + description: 'Last topology change. + + ' + type: string + max_hops: + description: Max Hops + format: int32 + type: integer + mstp_enabled: + description: 'The MSTP enabled. True or False. + + ' + type: boolean + root_bridge_id: + description: Root Bridge Id + type: string + root_path_cost: + description: Root Path Cost + format: int32 + type: integer + root_port: + description: Root Port + type: string + stp_aging_timer: + description: "The STP aging Timer between 10 - 1000000 seconds. \ + \ \n" + format: int32 + type: integer + 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: "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: '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: 'The STP Mode is RSTP, default STP mode is RSTP + + ' + type: string + stp_priority: + description: 'The Priority value is between 0 - 61440, in multiples of 4096. + + ' + format: int32 + type: integer + TrackInterface: + properties: + interface_id: + description: 'The interface ID + + ' + type: string + reduce_priority: + description: 'Reduce priority of the spoke HA config. + + ' + format: int32 + type: integer + TrackV1: + properties: + interfaces: + description: 'Interfaces: Valid ' + items: + $ref: '#/components/schemas/TrackInterface' + type: array + TrackV2: + properties: + interfaces: + description: 'The details of the interfaces. + + ' + items: + $ref: '#/components/schemas/TrackInterface' + type: array + waninterfaces: + description: 'Waninterfaces: Valid ' + items: + $ref: '#/components/schemas/TrackWANInterface' + type: array + TrackWANInterface: + properties: + reduce_priority: + description: 'Reduce priority of the spoke HA config. + + ' + format: int32 + type: integer + wan_interface_id: + description: 'The WAN interface ID + + ' + type: string + VffInventoryOperation: + enum: + - grant + - return + - revoke + type: string + VffLicense: + properties: + allowed_ions: + description: 'The number of allowed ions. + + ' + format: int32 + type: integer + id: + description: 'The ID of ION. + + ' + type: string + model: + description: 'The model of the ION. + + ' + type: string + required: + - model + VffLicenseQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of vff licenses that match the query + parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of vff licenses deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the vff licenses for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the vff licenses 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 + VffLicenseState: + properties: + deployed_ions: + description: 'The number of deployed IONs. + + ' + format: int32 + type: integer + id: + description: 'The ID of the vff license. + + ' + type: string + VffLicenseStateQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of vff license states that match the + query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of vff license states deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the vff license states for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the vff license states 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 + VffLicenseStateV2: + properties: + deployed_ions: + description: 'The number of deployed IONs. + + ' + format: int32 + type: integer + id: + description: 'The ID of the vff license. + + ' + type: string + source_license_id: + description: 'The source license ID of the IONs. + + ' + type: string + source_tenant_id: + description: 'The source tenant ID. + + ' + type: string + VffLicenseV2: + properties: + allocated_ions: + description: 'The number of allocated IONs in the inventory. + + ' + format: int32 + type: integer + allowed_ions: + description: 'The maximum number of IONs that are allowed. + + ' + format: int32 + type: integer + id: + description: 'The ID of the IONs. + + ' + type: string + model: + description: 'The model of the ION devices. + + ' + type: string + source_license_id: + description: 'The source license ID of the IONs. + + ' + type: string + source_tenant_id: + description: 'The source tenant ID. + + ' + type: string + required: + - model + VffOperationInfo: + properties: + inventory_op: + $ref: '#/components/schemas/VffInventoryOperation' + description: 'The details of the operation in the inventory. + + ' + ions_count: + description: 'The number of IONs in the inventory. + + ' + type: integer + tenant_id: + description: 'The tenant ID. + + ' + type: string + type: object + VffToken: + properties: + id: + description: 'The ID of the vff token. + + ' + type: string + ion_key: + description: 'The ION key. + + ' + type: string + is_expired: + description: 'Is vff token expired. True or False. + + ' + type: boolean + is_multiuse: + description: 'Is the vff token multiuse. True or False. + + ' + type: boolean + is_revoked: + description: "Can the vff token be revoked. True or False. \n" + type: boolean + is_used: + description: 'Is the vff token in use. True or False. + + ' + type: boolean + secret_key: + description: 'The secret key. + + ' + type: string + valid_till_secs: + description: 'The token valid time in seconds. + + ' + format: int64 + type: integer + vfflicense_id: + description: 'The vff license ID. + + ' + type: string + VffTokenQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of vff tokens that match the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of vff tokens deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the vff tokens for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the vff tokens 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 + VffTokenQueryFilter: + properties: + id: + description: 'The ID of the vff token. + + ' + type: string + ion_key: + description: 'The ION key. + + ' + type: string + is_expired: + description: 'Is vff token expired. True or False. + + ' + type: boolean + is_multiuse: + description: 'Is the vff token multiuse. True or False. + + ' + type: boolean + is_revoked: + description: "Can the vff token be revoked. True or False. \n" + type: boolean + is_used: + description: 'Is the vff token in use. True or False. + + ' + type: boolean + secret_key: + description: 'The secret key. + + ' + type: string + valid_till_secs: + description: 'The token valid time in seconds. + + ' + format: int64 + type: integer + vfflicense_id: + description: 'The vff license ID. + + ' + type: string + VffTokenScreen: + properties: + id: + description: 'The ID of the vff token. + + ' + type: string + ion_key: + description: 'The ION key. + + ' + type: string + is_expired: + description: 'Is vff token expired. True or False. + + ' + type: boolean + is_multiuse: + description: 'Is the vff token multiuse. True or False. + + ' + type: boolean + is_revoked: + description: "Can the vff token be revoked. True or False. \n" + type: boolean + is_used: + description: 'Is the vff token in use. True or False. + + ' + type: boolean + secret_key: + description: 'The secret key. + + ' + type: string + valid_till_secs: + description: 'The token valid time in seconds. + + ' + format: int64 + type: integer + vfflicense_id: + description: 'The vff license ID. + + ' + type: string + VlanConfig: + properties: + element_vlan_unique_id: + description: 'The element VLAN unique ID. + + ' + type: string + mstp_instance: + description: Mstp Instance + format: int32 + type: integer + vlan_id: + description: 'The VLAN ID. + + ' + format: int32 + type: integer + voice_enabled: + description: 'The voice enabled VLAN. + + ' + type: boolean + X509Objects: + properties: + certHolder: + type: object + certificate: + description: Certificate + type: string + is_local_ca_cert_set: + description: Is Local Ca Cert Set + type: boolean + is_remote_ca_cert_set: + description: Is Remote Ca Cert Set + type: boolean + keyPair: + type: object + local_ca_certificate: + description: Local Ca Certificate + type: string + local_ca_certs_set: + description: Local Ca Certs Set + items: + type: object + type: array + passphrase: + description: Passphrase + type: string + private_key: + description: Private Key + type: string + remote_ca_certificate: + description: Remote Ca Certificate + type: string + remote_ca_certs_set: + description: Remote Ca Certs Set + items: + type: object + type: array +info: + contact: {} + description: List of APIs used to manage your device software to upgrade, retrieve + available software images, and upgrade status information. + title: Device Configuration + version: Latest +openapi: 3.0.0 +paths: + /v2.0/api/tenants/{tenant_id}/clients/{client_id}/machines: + get: + description: Get all machines of tenant + operationId: get-v2.0-api-tenants-tenant_id-clients-client_id-machines + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Client Id + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/MachineV2N2' + type: array + type: object + description: Successful Operation + summary: Get all machines of tenant (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/clients/{client_id}/machines/query: + post: + description: Query a tenants client + operationId: post-v2.0-api-tenants-tenant_id-clients-client_id-machines-query + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Client Id + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Machine' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Machine' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_OPERATION + - code: INVALID_STATE + - code: OPERATION_NOT_ALLOWED + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: NAME_EXCEEDS_LIMIT + - code: DESCRIPTION_EXCEEDS_LIMIT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query a tenants client (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/clients/{client_id}/machines/{machine_id}: + get: + description: Get specific machine belonging to tenant + operationId: get-v2.0-api-tenants-tenant_id-clients-client_id-machines-machine_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Client Id + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + - description: Machine Id + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/Machine' + type: array + description: Successful Operation + summary: Get specific machine belonging to tenant (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/clients/{client_id}/machines/{machine_id}/reallocate: + post: + description: Update Tenant machine + operationId: post-v2.0-api-tenants-tenant_id-clients-client_id-machines-machine_id-reallocate + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Client Id + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + - description: Machine Id + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Machine' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Machine' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_OPERATION + - code: INVALID_STATE + - code: OPERATION_NOT_ALLOWED + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: NAME_EXCEEDS_LIMIT + - code: DESCRIPTION_EXCEEDS_LIMIT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Tenant machine (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/elements: + get: + description: Get all elements of a tenant in a site + operationId: get-v2.0-api-tenants-tenant_id-elements + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + responses: + '200': + content: + application/json: + schema: + oneOf: + - allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilter' + type: array + type: object + - allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilter' + type: array + type: object + description: Successful Operation + summary: Get all elements of a tenant in a site (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/elements/query: + post: + description: Query db for elements that match query parameters + operationId: post-v2.0-api-tenants-tenant_id-elements-query + 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/ElementQueryFilter' + description: Details of the query to be created. + 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: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query db for elements that match query parameters (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/elements/software/state/query: + post: + description: Query the software state for all the tenant's elements. + operationId: post-v2.0-api-tenants-tenant_id-elements-software-state-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/ElementStateQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementStateQueryFilter' + type: array + type: object + description: Successful Operation + summary: Query Software State for Tenant's Elements (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/elements/status/query: + post: + description: Query and get element status objects for a tenant + operationId: post-v2.0-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 + summary: Query and get element status objects for a tenant (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/elements/{element_id}: + get: + description: Get element of a tenant + operationId: get-v2.0-api-tenants-tenant_id-elements-element_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Element' + description: Successful Operation + summary: Get element of a tenant (v2.0) + tags: + - Device Configuration + put: + description: Used for associations and element updates + operationId: put-v2.0-api-tenants-tenant_id-elements-element_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreen' + description: Details of the element to be updated. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Element' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_BOUND_ERROR + - code: ELEMENT_CONFIG_INVALID_VALUES + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Used for associations and element updates (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/elements/{element_id}/certificate_operations: + post: + description: Start the CIC renewal process for an element device. + operationId: post-v2.0-api-tenants-tenant_id-elements-element_id-certificate_operations + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementOperations' + description: Details of the operations on element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementOperations' + description: Successful Operation + summary: CIC Renewal Process for Element Device (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/elements/{element_id}/hardwarebypass: + get: + description: List all the hardware bypasses in an element. + operationId: get-v2.0-api-tenants-tenant_id-elements-element_id-hardwarebypass + 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/HardwareBypass' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INTERFACE_CONFIG_HWBYPASS_NOT_SUPPORTED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Hardware Bypasses in Element (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/elements/{element_id}/operations: + post: + description: Handle all the operations on an element. + operationId: post-v2.0-api-tenants-tenant_id-elements-element_id-operations + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementOperations' + description: Details of the operations on element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementOperations' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: COMMAND_NOT_SUPPORTED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Handle Operations on Element (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/elements/{element_id}/software/state: + get: + description: Get the software upgrade configuration of an element. + operationId: get-v2.0-api-tenants-tenant_id-elements-element_id-software-state + 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/ElementSoftwareState' + description: Successful Operation + summary: Get Software Upgrade Configuration of Element (v2.0) + tags: + - Device Configuration + put: + description: Upgrade an element. + operationId: put-v2.0-api-tenants-tenant_id-elements-element_id-software-state + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementSoftwareStateScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementSoftwareState' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SOFTWARE_CONFIG_INVALID_SCHEDULING + - code: SOFTWARE_CONFIG_SCHEDULED_UPGRADE_NOT_SUPPORTED + - code: SOFTWARE_CONFIG_INVALID_DOWNLOAD_INTERVAL + - code: SOFTWARE_CONFIG_INVALID_UPGRADE_INTERVAL + - code: SOFTWARE_CONFIG_INVALID_DOWNLOAD_TIME + - code: SOFTWARE_CONFIG_INVALID_UPGRADE_TIME + - code: SOFTWARE_CONFIG_INCOMPATIBLE_SCHEDULES + - code: SOFTWARE_CONFIG_INVALID_INTERFACES + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Upgrade an Element (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/elements/{element_id}/software/status: + get: + description: Get the image status. + operationId: get-v2.0-api-tenants-tenant_id-elements-element_id-software-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/ElementImageStatus' + description: Successful Operation + summary: Get Image Status (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/elements/{element_id}/state: + get: + description: Get the element state. + operationId: get-v2.0-api-tenants-tenant_id-elements-element_id-state + 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/ElementState' + description: Successful Operation + summary: Get Element State (v2.0) + tags: + - Device Configuration + put: + description: Update the element state. + operationId: put-v2.0-api-tenants-tenant_id-elements-element_id-state + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementStateScreen' + description: Update element state + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementState' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_BOUND_ERROR + - code: ELEMENT_CONFIG_INVALID_VALUES + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Element State (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/elements/{element_id}/status: + get: + description: Get specific element status for a tenant + operationId: get-v2.0-api-tenants-tenant_id-elements-element_id-status + parameters: + - in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - in: path + name: element_id + required: true + schema: + description: Element Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementStatus' + 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 specific element status for a tenant (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/machines: + get: + description: Get machines of a tenant + operationId: get-v2.0-api-tenants-tenant_id-machines + parameters: + - in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: MACHINE_UNKNOWN + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get machines of a tenant (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/machines/query: + post: + description: Query a specific machine of a tenant + operationId: post-v2.0-api-tenants-tenant_id-machines-query + parameters: + - in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ESP_OPERATION_NOT_ALLOWED + - code: INVALID_OPERATION + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: SELF_ESP_RECEIVE_STOCK_ERROR + - code: INVALID_ESP_CLIENT + - code: MACHINE_UNKNOWN + - code: INVALID_STATE + - code: LICENSE_NOT_FOUND + - code: MACHINE_INACTIVE + - code: MACHINE_DISCONNECTED + - code: PLEASE_RETRY_LATER + - code: CLAIM_ALREADY_IN_PROGRESS + - code: OPERATION_NOT_ALLOWED + - code: INVALID_ESP_MACHINE_STATE + - code: INVALID_ESP_FOR_MACHINE + - code: OPERATION_NOT_ALLOWED_FOR_VFF + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query a specific machine of a tenant (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/machines/{machine_id}: + get: + description: Get Tenant machine + operationId: get-v2.0-api-tenants-tenant_id-machines-machine_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Machine Id + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Machine' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - 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.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/machines/{machine_id}/operations: + post: + description: Update Tenant machine + operationId: post-v2.0-api-tenants-tenant_id-machines-machine_id-operations + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Machine Id + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Machine' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Machine' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - 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: Update Tenant 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. + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-admin_state + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Element' + description: Update admin state + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Element' + description: Successful Operation + summary: Update Admin State Northbound (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/application_probe: + get: + description: Get the application probe configuration of an element. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-application_probe + 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 + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationProbe' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPLICATION_PROBE_CONFIG_UNSUPPORTED_SWVERSION + - code: APPLICATION_PROBE_CONFIG_NOT_PRESENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Application Probe Configuration (v2.0) + tags: + - Device Configuration + put: + description: Update the application probe configuration of an element. + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-application_probe + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationProbeScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationProbe' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPLICATION_PROBE_CONFIG_UNSUPPORTED_SWVERSION + - code: APPLICATION_PROBE_CONFIG_UNSUPPORTED_ROLE + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: APPLICATION_PROBE_CONFIG_INVALID_SOURCE_INTERFACE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Application Probe Configuration (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/extensions: + get: + description: List all the element level extensions. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-extensions + 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 + responses: + '200': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/ListResponse' + 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 Element Level Extensions (v2.0) + tags: + - Device Configuration + post: + description: Create an element level extension configuration. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-extensions + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExtensionScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: SITE_NOT_FOUND + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: INVALID_JSON_INPUT + - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Element Level Extension Configuration (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/extensions/query: + post: + description: Query element level extensions that match query parameters. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-extensions-query + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExtensionQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ExtensionQuery' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: SITE_NOT_FOUND + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: INVALID_JSON_INPUT + - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Element Level Extensions (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/extensions/{extension_id}: + delete: + description: Delete a specific extension associated with an element. + operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-extensions-extension_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 extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: EXTENSION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Element Level Extension (v2.0) + tags: + - Device Configuration + get: + description: Get a specific extension associated with an element. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-extensions-extension_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 extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: EXTENSION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Element Level Extension (v2.0) + tags: + - Device Configuration + put: + description: Update an element level extension configuration. + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-extensions-extension_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 extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExtensionScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_INPUT + - code: EXTENSION_NOT_FOUND + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Element Level Extension (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: + get: + description: Get interface status + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id-status + parameters: + - description: Tenant Id + 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceState' + description: Successful Operation + summary: Get interface status (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/extensions: + get: + description: List all the site level extensions. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-extensions + 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: + oneOf: + - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/ListResponse' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SITE_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Site Level Extensions (v2.0) + tags: + - Device Configuration + post: + description: Create site level extension configuration. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-extensions + 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/ExtensionScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: SITE_NOT_FOUND + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: INVALID_JSON_INPUT + - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Site Level Extension Configuration (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/extensions/query: + post: + description: Query site level extensions that match query parameters. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-extensions-query + 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/ExtensionQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ExtensionQuery' + type: array + type: object + description: Successful Operation + summary: Query Site Level Extension (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/extensions/{extension_id}: + delete: + description: Delete a specific extension associated with a site. + operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-extensions-extension_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 extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: EXTENSION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Site Level Extension (v2.0) + tags: + - Device Configuration + get: + description: Get a specific extension associated with a site. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-extensions-extension_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 extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: EXTENSION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Site Level Extension (v2.0) + tags: + - Device Configuration + put: + description: Update a specific extension configuration associated with a site. + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-extensions-extension_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 extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExtensionScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_INPUT + - code: EXTENSION_NOT_FOUND + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Site Level Extension Configuration (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/vfflicenses: + get: + description: List all the Vff license for a tenant. + operationId: get-v2.0-api-tenants-tenant_id-vfflicenses + 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/VffLicense' + type: array + type: object + description: Successful Operation + summary: Get Vff License for Tenant (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/vfflicenses/rquery: + post: + description: Query to get the virtual device(vff) license. + operationId: post-v2.0-api-tenants-tenant_id-vfflicenses-rquery + 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/VffLicenseQuery' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VffLicenseQuery' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_MODEL + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query and Get Vff License (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/vfflicenses/tokens/query: + post: + description: Query all the tenant Vff license tokens. + operationId: post-v2.0-api-tenants-tenant_id-vfflicenses-tokens-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/VffTokenQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/VffTokenQueryFilter' + type: array + type: object + description: Successful Operation + summary: Query Vff License Tokens (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/vfflicenses/{license_id}: + get: + description: List all the specific Vff licenses for a tenant. + operationId: get-v2.0-api-tenants-tenant_id-vfflicenses-license_id + 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/VffLicense' + description: Successful Operation + summary: Get Vff Licenses for Tenant (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/vfflicenses/{license_id}/operations: + post: + description: 'List the vff operations. + + ' + operationId: post-v2.0-api-tenants-tenant_id-vfflicenses-license_id-operations + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: License Id + in: path + name: license_id + required: true + schema: + description: License Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VffOperationInfo' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VffLicenseV2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_CHILD_TENANT + - code: INVALID_VFF_LICENSE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Vff Operation (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/vfflicenses/{license_id}/status: + get: + description: List the status for the Vff license. + operationId: get-v2.0-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/VffLicenseState' + description: Successful Operation + summary: Get Status for Vff License (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/vfflicenses/{license_id}/tokens: + get: + description: List all the tenant Vff license tokens. + operationId: get-v2.0-api-tenants-tenant_id-vfflicenses-license_id-tokens + 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: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/VffToken' + type: array + type: object + description: Successful Operation + summary: Get Tenant Vff License Tokens (v2.0) + tags: + - Device Configuration + post: + description: Create a tenant Vff license token. + operationId: post-v2.0-api-tenants-tenant_id-vfflicenses-license_id-tokens + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VffToken' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VffToken' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: TOKEN_CONFIG_INVALID_POST_VALUES + - code: LICENSE_UNKNOWN + - code: ION_MAX_LIMIT + - code: ERROR_IN_TOKEN_GENERATION + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Tenant Vff License Token (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/vfflicenses/{license_id}/tokens/{token_id}: + get: + description: List a specific tenant Vff license token. + operationId: get-v2.0-api-tenants-tenant_id-vfflicenses-license_id-tokens-token_id + 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 + - description: The token ID. + in: path + name: token_id + required: true + schema: + description: Token Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VffToken' + description: Successful Operation + summary: Get Tenant Vff License Token (v2.0) + tags: + - Device Configuration + put: + description: Update a specific tenant Vff license token. + operationId: put-v2.0-api-tenants-tenant_id-vfflicenses-license_id-tokens-token_id + 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 + - description: The token ID. + in: path + name: token_id + required: true + schema: + description: Token Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VffTokenScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VffToken' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: TOKEN_CONFIG_INVALID_PUT_VALUES + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Tenant Vff License Token (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/vfflicensesstatus/rquery: + post: + 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. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VffLicenseStateQuery' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VffLicenseStateQuery' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_MODEL + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query to Get Vff License State (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/ws/extensions: + get: + description: List all the extensions from NB. + operationId: get-v2.0-api-tenants-tenant_id-ws-extensions + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + responses: + '200': + content: + application/json: + schema: + oneOf: + - allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/Extension' + type: array + type: object + - allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ExtensionQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: EXTENSION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Extensions from NB (v2.0) + tags: + - Device Configuration + post: + description: Create an extension configuration. + operationId: post-v2.0-api-tenants-tenant_id-ws-extensions + 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/Extension' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: EXTENSION_NAME_REQD + - code: INVALID_EXTENSION_CONF + - code: INVALID_EXTENSION_NAMESPACE + - code: EXTENSION_NAMESPACE_REQD + - code: INVALID_EXTENSION_NAME + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Extension Configuration (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/ws/extensions/query: + post: + description: Query the DB for limit number of tenant extensions that match the + query params. + operationId: post-v2.0-api-tenants-tenant_id-ws-extensions-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/ExtensionQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ExtensionQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_ERROR_0001 + - code: INVALID_REQUEST_DUPLICATE_KEY + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Tenant Extensions (v2.0) + tags: + - Device Configuration + /v2.0/api/tenants/{tenant_id}/ws/extensions/{extension_id}: + delete: + description: Delete a specific extension configuration. + operationId: delete-v2.0-api-tenants-tenant_id-ws-extensions-extension_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: EXTENSION_NAME_REQD + - code: INVALID_EXTENSION_CONF + - code: INVALID_EXTENSION_NAMESPACE + - code: EXTENSION_NAMESPACE_REQD + - code: INVALID_EXTENSION_NAME + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Extensions Configuration (v2.0) + tags: + - Device Configuration + get: + description: Get a specific extension configuration from the NB. + operationId: get-v2.0-api-tenants-tenant_id-ws-extensions-extension_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + summary: Get Extensions Configuration from NB (v2.0) + tags: + - Device Configuration + put: + description: Update a specific extension configuration. + operationId: put-v2.0-api-tenants-tenant_id-ws-extensions-extension_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: EXTENSION_NAME_REQD + - code: INVALID_EXTENSION_CONF + - code: INVALID_EXTENSION_NAMESPACE + - code: EXTENSION_NAMESPACE_REQD + - code: INVALID_EXTENSION_NAME + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Extensions Configuration (v2.0) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/clients/{client_id}/machines: + get: + description: Get all machines allocated by ESP to a client tenant + operationId: get-v2.1-api-tenants-tenant_id-clients-client_id-machines + parameters: + - description: tenant ID of the ESP + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: tenant ID of the client tenant of ESP + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + type: object + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: INVALID_ESP_CLIENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get all machines allocated by ESP to a client tenant (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/clients/{client_id}/machines/query: + post: + description: Query and get all machines allocated by ESP to a client tenant + operationId: post-v2.1-api-tenants-tenant_id-clients-client_id-machines-query + parameters: + - description: tenant ID of the ESP + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: tenant ID of the client tenant of ESP + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + type: object + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_ESP_CLIENT + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query and get all machines allocated by ESP to a client tenant (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/clients/{client_id}/machines/{machine_id}: + get: + description: Get a specific machine allocated by ESP to a client tenant + operationId: get-v2.1-api-tenants-tenant_id-clients-client_id-machines-machine_id + parameters: + - description: tenant ID of the ESP + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: tenant ID of the client tenant of ESP + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + - in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: INVALID_ESP_CLIENT + - code: MACHINE_UNKNOWN + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get a specific machine allocated by ESP to a client tenant (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/clients/{client_id}/machines/{machine_id}/reallocate: + post: + description: Reallocate a specific machine from one client tenant to another, + both client tenants are clients of the same ESP. + operationId: post-v2.1-api-tenants-tenant_id-clients-client_id-machines-machine_id-reallocate + parameters: + - description: tenant ID of the ESP + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: tenant ID (source) of the client tenant of ESP + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + - in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineInfo' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_ESP_CLIENT + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: MACHINE_UNKNOWN + - code: OPERATION_NOT_ALLOWED + - code: INVALID_OPERATION + - code: INVALID_STATE + description: If the machine is not in to_be_returned state or + allocated_to_esp states, use /operations API to move it to to_be_returned + (return operation) or allocated_to_esp (esp_received stock operation) + state, before attempting to reallocate the machine to another + client tenant. + - code: MACHINE_DELETE_DEFAULT_REGION + - code: INVALID_MACHINE_REGION + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Reallocate a specific machine from one client tenant to another, both + client tenants are clients of the same ESP. (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/elements: + get: + description: Get all elements of a tenant in a site + operationId: get-v2.1-api-tenants-tenant_id-elements + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + responses: + '200': + content: + application/json: + schema: + oneOf: + - allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilterV2N1' + type: array + type: object + - allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/Element' + type: array + type: object + description: Successful Operation + summary: Get all elements of a tenant in a site (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/elements/query: + post: + description: Query db for elements that match query parameters + operationId: post-v2.1-api-tenants-tenant_id-elements-query + 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/ElementQuery' + description: Details of the query to be created. + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilterV2N1' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_JSON + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_CLAIMED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query db for elements that match query parameters (v2.1) + 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}: + get: + description: Get element of a tenant + operationId: get-v2.1-api-tenants-tenant_id-elements-element_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementV2N1' + description: Successful Operation + summary: Get element of a tenant (v2.1) + tags: + - Device Configuration + put: + description: Used for associations and element updates + operationId: put-v2.1-api-tenants-tenant_id-elements-element_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV2N1' + description: Details of the element to be updated. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_BOUND_ERROR + - code: ELEMENT_CONFIG_INVALID_VALUES + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Used for associations and element updates (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. + operationId: post-v2.1-api-tenants-tenant_id-elements-element_id-fips_mode_change_operations + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementOperations' + description: Details of the operations on element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementOperations' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: FIPS_MODE_INVALID_OPERATION + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_CONNECTED + - code: FIPS_MODE_ELEMENT_ALREADY_IN_REQUESTED_MODE + - code: FIPS_MODE_MODEL_NOT_SUPPORTED + - code: FIPS_MODE_FORBIDDEN_INVALID_STATE + - code: FIPS_MODE_CHANGE_NOT_SUPPORTED + - code: FIPS_MODE_PLEASE_RETRY_LATER + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Change Mode of Element from FIPS to Non-FIPS (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/elements/{element_id}/software/status: + get: + description: List all the software upgrade status (up to 5) started by the tenant + user. + operationId: get-v2.1-api-tenants-tenant_id-elements-element_id-software-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: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementImageStatusV2N1' + type: array + type: object + description: Successful Operation + summary: Get Software Upgrade Status (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/elements/{element_id}/status: + get: + description: Get specific element status for a tenant + operationId: get-v2.1-api-tenants-tenant_id-elements-element_id-status + parameters: + - in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - 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 specific element status for a tenant (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/machines: + get: + description: Get all machines of a tenant + operationId: get-v2.1-api-tenants-tenant_id-machines + parameters: + - 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/MachineV2N1' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '404': + description: Machines not found + summary: Get all machines of a tenant (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/machines/query: + post: + description: Query and get machines of a tenant + operationId: post-v2.1-api-tenants-tenant_id-machines-query + parameters: + - in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/MachineQueryFilterV2N1' + 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 and get machines of a tenant (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/machines/{machine_id}: + get: + description: Get a specific machine of a tenant + operationId: get-v2.1-api-tenants-tenant_id-machines-machine_id + parameters: + - in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: MACHINE_UNKNOWN + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get a specific machine of a 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. + operationId: get-v2.1-api-tenants-tenant_id-machines-machine_id-machinesystemstatus + 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 + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineSystemStatusV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: MACHINE_UNKNOWN + - code: MACHINE_STATUS_UNKNOWN + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Machine System Status (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/machines/{machine_id}/operations: + post: + description: Update a specific machine of a tenant using operations + operationId: post-v2.1-api-tenants-tenant_id-machines-machine_id-operations + parameters: + - in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineInfo' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ESP_OPERATION_NOT_ALLOWED + - code: INVALID_OPERATION + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: SELF_ESP_RECEIVE_STOCK_ERROR + - code: INVALID_ESP_CLIENT + - code: MACHINE_UNKNOWN + - code: INVALID_STATE + - code: LICENSE_NOT_FOUND + - code: MACHINE_INACTIVE + - code: MACHINE_DISCONNECTED + - code: PLEASE_RETRY_LATER + - code: CLAIM_ALREADY_IN_PROGRESS + - code: OPERATION_NOT_ALLOWED + - code: INVALID_ESP_MACHINE_STATE + - code: INVALID_ESP_FOR_MACHINE + - code: OPERATION_NOT_ALLOWED_FOR_VFF + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update a specific machine of a tenant using operations (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/machines/{machine_id}/recovery_tokens: + get: + description: Get the recovery token for a machine. + operationId: get-v2.1-api-tenants-tenant_id-machines-machine_id-recovery_tokens + 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 + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RecoveryToken' + description: Successful Operation + summary: Get Recovery Token for Machine (v2.1) + tags: + - Device Configuration + post: + description: Create a recovery token for the FIPs change mode. + operationId: post-v2.1-api-tenants-tenant_id-machines-machine_id-recovery_tokens + 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/RecoveryTokenScreen' + description: Details of the recovery token for the element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RecoveryToken' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: MACHINE_NOT_FOUND + - code: FIPS_MODE_ERROR_IN_TOKEN_GENERATION + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Recovery Token for FIPs (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/machines/{machine_id}/recovery_tokens/{token_id}: + put: + description: Update a recovery token for the FIPs change mode. + operationId: put-v2.1-api-tenants-tenant_id-machines-machine_id-recovery_tokens-token_id + 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 + - description: The token ID. + in: path + name: token_id + required: true + schema: + description: Token Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RecoveryTokenScreen' + description: Details of the recovery token for the element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RecoveryToken' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: MACHINE_NOT_FOUND + - code: TOKEN_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Recovery Token for FIPs (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/software/current_status/query: + post: + description: Get the current image status of all the elements. + operationId: post-v2.1-api-tenants-tenant_id-software-current_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/ElementImageStatusQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementImageStatusQueryFilterV2N1' + type: array + type: object + description: Successful Operation + summary: Get Image Status of Element (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/software/status/query: + post: + description: Query the software upgrade status of all the tenant elements. + operationId: post-v2.1-api-tenants-tenant_id-software-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/ElementImageStatusQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementImageStatusQueryFilterV2N1' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Software Upgrade Status (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/vfflicenses: + get: + description: List all the Vff licenses for a tenant. + operationId: get-v2.1-api-tenants-tenant_id-vfflicenses + 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/VffLicenseV2' + type: array + type: object + description: Successful Operation + summary: Get Vff Licenses for Tenant (v2.1) + tags: + - Device Configuration + /v2.1/api/tenants/{tenant_id}/vfflicenses/{license_id}: + get: + description: List all the specific Vff licenses for a tenant. + operationId: get-v2.1-api-tenants-tenant_id-vfflicenses-license_id + 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/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}/clients/{client_id}/machines: + get: + description: Get all machines allocated by ESP to a client tenant + operationId: get-v2.2-api-tenants-tenant_id-clients-client_id-machines + parameters: + - description: tenant ID of the ESP + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: tenant ID of the client tenant of ESP + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + type: object + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: INVALID_ESP_CLIENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get all machines allocated by ESP to a client tenant (v2.2) + tags: + - Device Configuration + /v2.2/api/tenants/{tenant_id}/clients/{client_id}/machines/query: + post: + description: Query and get all machines allocated by ESP to a client tenant + operationId: post-v2.2-api-tenants-tenant_id-clients-client_id-machines-query + parameters: + - description: tenant ID of the ESP + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: tenant ID of the client tenant of ESP + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + type: object + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_ESP_CLIENT + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query and get all machines allocated by ESP to a client tenant (v2.2) + tags: + - Device Configuration + /v2.2/api/tenants/{tenant_id}/clients/{client_id}/machines/{machine_id}: + get: + description: Get a specific machine allocated by ESP to a client tenant + operationId: get-v2.2-api-tenants-tenant_id-clients-client_id-machines-machine_id + parameters: + - description: tenant ID of the ESP + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: tenant ID of the client tenant of ESP + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + - in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: INVALID_ESP_CLIENT + - code: MACHINE_UNKNOWN + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get a specific machine allocated by ESP to a client tenant (v2.2) + tags: + - Device Configuration + /v2.2/api/tenants/{tenant_id}/clients/{client_id}/machines/{machine_id}/reallocate: + post: + description: Reallocate a specific machine from one client tenant to another, + both client tenants are clients of the same ESP. + operationId: post-v2.2-api-tenants-tenant_id-clients-client_id-machines-machine_id-reallocate + parameters: + - description: tenant ID of the ESP + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: tenant ID (source) of the client tenant of ESP + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + - in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineInfoV2N2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_ESP_CLIENT + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: MACHINE_UNKNOWN + - code: OPERATION_NOT_ALLOWED + - code: INVALID_OPERATION + - code: INVALID_STATE + description: If the machine is not in to_be_returned state or + allocated_to_esp states, use /operations API to move it to to_be_returned + (return operation) or allocated_to_esp (esp_received stock operation) + state, before attempting to reallocate the machine to another + client tenant. + - code: MACHINE_DELETE_DEFAULT_REGION + - code: INVALID_MACHINE_REGION + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Reallocate a specific machine from one client tenant to another, both + client tenants are clients of the same ESP. (v2.2) + tags: + - Device Configuration + /v2.2/api/tenants/{tenant_id}/elements: + get: + description: Get all elements of a tenant in a site + operationId: get-v2.2-api-tenants-tenant_id-elements + parameters: + - description: 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/ElementV2N2' + type: array + type: object + description: Successful Operation + summary: Get all elements of a tenant in a site (v2.2) + tags: + - Device Configuration + /v2.2/api/tenants/{tenant_id}/elements/query: + post: + description: Query db for elements that match query parameters + operationId: post-v2.2-api-tenants-tenant_id-elements-query + 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/ElementQuery' + description: Details of the query to be created. + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilterV2N2' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_JSON + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_CLAIMED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query db for elements that match query parameters (v2.2) + tags: + - Device Configuration + /v2.2/api/tenants/{tenant_id}/elements/{element_id}: + get: + description: Get element of a tenant + operationId: get-v2.2-api-tenants-tenant_id-elements-element_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementV2N2' + description: Successful Operation + summary: Get element of a tenant (v2.2) + tags: + - Device Configuration + put: + description: Used for associations and element updates + operationId: put-v2.2-api-tenants-tenant_id-elements-element_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV2N2' + description: Details of the element to be updated. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_BOUND_ERROR + - code: ELEMENT_HA_CONFIG_NOT_SUPPORTED + - code: ELEMENT_CONFIG_INVALID_VALUES + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Used for associations and element updates (v2.2) + tags: + - Device Configuration + /v2.2/api/tenants/{tenant_id}/machines: + get: + description: Get all machines of a tenant + operationId: get-v2.2-api-tenants-tenant_id-machines + parameters: + - 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/MachineV2N2' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '404': + description: Machines not found + summary: Get all machines of a tenant (v2.2) + tags: + - Device Configuration + /v2.2/api/tenants/{tenant_id}/machines/query: + post: + description: Query and get machines of a tenant + operationId: post-v2.2-api-tenants-tenant_id-machines-query + parameters: + - in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/MachineQueryFilterV2N2' + 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 and get machines of a tenant (v2.2) + tags: + - Device Configuration + /v2.2/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 + parameters: + - in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: MACHINE_UNKNOWN + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get a specific machine of a tenant (v2.2) + tags: + - Device Configuration + /v2.2/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 + parameters: + - in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineInfoV2N2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ESP_OPERATION_NOT_ALLOWED + - code: INVALID_OPERATION + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: SELF_ESP_RECEIVE_STOCK_ERROR + - code: INVALID_ESP_CLIENT + - code: MACHINE_UNKNOWN + - code: INVALID_STATE + - code: LICENSE_NOT_FOUND + - code: MACHINE_INACTIVE + - code: MACHINE_DISCONNECTED + - code: PLEASE_RETRY_LATER + - code: CLAIM_ALREADY_IN_PROGRESS + - code: OPERATION_NOT_ALLOWED + - code: INVALID_ESP_MACHINE_STATE + - code: INVALID_ESP_FOR_MACHINE + - code: OPERATION_NOT_ALLOWED_FOR_VFF + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update a specific machine of a tenant using operations (v2.2) + tags: + - Device Configuration + /v2.3/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 + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + type: object + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: INVALID_ESP_CLIENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Machines of Tenant (v2.3) + tags: + - Device Configuration + /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.3-api-tenants-tenant_id-clients-client_id-machines-query + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + type: object + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_ESP_CLIENT + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Tenant's Client (v2.3) + tags: + - Device Configuration + /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.3-api-tenants-tenant_id-clients-client_id-machines-machine_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + - description: The device ID. + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: INVALID_ESP_CLIENT + - code: MACHINE_UNKNOWN + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Machine of Tenant (v2.3) + tags: + - Device Configuration + /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.3-api-tenants-tenant_id-clients-client_id-machines-machine_id-reallocate + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + - description: The device ID. + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineInfoV2N3' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_ESP_CLIENT + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: MACHINE_UNKNOWN + - code: OPERATION_NOT_ALLOWED + - code: INVALID_OPERATION + - code: INVALID_STATE + description: If the machine is not in to_be_returned state or + allocated_to_esp states, use /operations API to move it to to_be_returned + (return operation) or allocated_to_esp (esp_received stock operation) + state, before attempting to reallocate the machine to another + client tenant. + - code: MACHINE_DELETE_DEFAULT_REGION + - code: INVALID_MACHINE_REGION + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Tenant Machine (v2.3) + tags: + - Device Configuration + /v2.3/api/tenants/{tenant_id}/elements: + get: + description: Get all elements of a tenant in a site + operationId: get-v2.3-api-tenants-tenant_id-elements + parameters: + - description: 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/ElementV2N3' + type: array + type: object + description: Successful Operation + summary: Get all elements of a tenant in a site (v2.3) + tags: + - Device Configuration + /v2.3/api/tenants/{tenant_id}/elements/query: + post: + description: Query db for elements that match query parameters + operationId: post-v2.3-api-tenants-tenant_id-elements-query + 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/ElementQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilterV2N3' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_JSON + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_CLAIMED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query db for elements that match query parameters (v2.3) + tags: + - Device Configuration + /v2.3/api/tenants/{tenant_id}/elements/{element_id}: + get: + description: Get element of a tenant + operationId: get-v2.3-api-tenants-tenant_id-elements-element_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementV2N3' + description: Successful Operation + summary: Get element of a tenant (v2.3) + tags: + - Device Configuration + put: + description: Used for associations and element updates + operationId: put-v2.3-api-tenants-tenant_id-elements-element_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV2N3' + description: Details of the element to be updated. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_BOUND_ERROR + - code: ELEMENT_CONFIG_INVALID_VALUES + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Used for associations and element updates (v2.3) + tags: + - Device Configuration + /v2.3/api/tenants/{tenant_id}/machines: + get: + description: Get all machines of a tenant + operationId: get-v2.3-api-tenants-tenant_id-machines + parameters: + - 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/MachineV2N3' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '404': + description: Machines not found + summary: Get all machines of a tenant (v2.3) + tags: + - Device Configuration + /v2.3/api/tenants/{tenant_id}/machines/query: + post: + description: Query the machines of a tenant. + operationId: post-v2.3-api-tenants-tenant_id-machines-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/MachineQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/MachineQueryFilterV2N3' + 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 Machine of Tenant (v2.3) + tags: + - Device Configuration + /v2.3/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 + 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 + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: MACHINE_UNKNOWN + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Tenant Machine (v2.3) + tags: + - Device Configuration + /v2.3/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 + 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/MachineInfoV2N3' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ESP_OPERATION_NOT_ALLOWED + - code: INVALID_OPERATION + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: SELF_ESP_RECEIVE_STOCK_ERROR + - code: INVALID_ESP_CLIENT + - code: MACHINE_UNKNOWN + - code: INVALID_STATE + - code: LICENSE_NOT_FOUND + - code: MACHINE_INACTIVE + - code: MACHINE_DISCONNECTED + - code: PLEASE_RETRY_LATER + - code: CLAIM_ALREADY_IN_PROGRESS + - code: OPERATION_NOT_ALLOWED + - code: INVALID_ESP_MACHINE_STATE + - code: INVALID_ESP_FOR_MACHINE + - code: OPERATION_NOT_ALLOWED_FOR_VFF + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Tenant Machine (v2.3) + tags: + - Device Configuration + /v2.4/api/tenants/{tenant_id}/elements: + get: + description: Get Elements of a tenant + operationId: get-v2.4-api-tenants-tenant_id-elements + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string - source_license_id: - description: 'The source license ID of the IONs. - - ' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementV2N4' + 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: Get Elements of a tenant (v2.4) + tags: + - Device Configuration + /v2.4/api/tenants/{tenant_id}/elements/query: + post: + description: Queries db for limit number of elements that match query params. + operationId: post-v2.4-api-tenants-tenant_id-elements-query + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string - source_tenant_id: - description: 'The source tenant ID. - - ' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementQuery' + description: Queries to the element + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilterV2N4' + 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: Queries db for limit number of elements that match query params. (v2.4) + tags: + - Device Configuration + /v2.4/api/tenants/{tenant_id}/elements/{element_id}: + get: + description: Get Element of a tenant + operationId: get-v2.4-api-tenants-tenant_id-elements-element_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string - VffLicenseV2: - properties: - allocated_ions: - description: 'The number of allocated IONs in the inventory. - - ' - format: int32 - type: integer - allowed_ions: - description: 'The maximum number of IONs that are allowed. - - ' - format: int32 - type: integer - id: - description: 'The ID of the IONs. - - ' + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id type: string - model: - description: 'The model of the ION devices. - - ' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementV2N4' + description: Successful Operation + summary: Get Element of a tenant (v2.4) + tags: + - Device Configuration + put: + description: Used for associations and element updates + operationId: put-v2.4-api-tenants-tenant_id-elements-element_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string - source_license_id: - description: 'The source license ID of the IONs. - - ' + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id type: string - source_tenant_id: - description: 'The source tenant ID. - - ' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV2N4' + description: Update to the element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV2N4' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_JSON + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_CLAIMED + - code: SITE_NOT_FOUND + - code: ELEMENT_BOUND_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Used for associations and element updates (v2.4) + tags: + - Device Configuration + /v2.5/api/tenants/{tenant_id}/elements: + get: + description: Get Elements of a tenant + operationId: get-v2.5-api-tenants-tenant_id-elements + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string - required: - - model - VffOperationInfo: - properties: - inventory_op: - $ref: '#/components/schemas/VffInventoryOperation' - description: 'The details of the operation in the inventory. - - ' - ions_count: - description: 'The number of IONs in the inventory. - - ' - type: integer - tenant_id: - description: 'The tenant ID. - - ' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementV2N5' + type: array + type: object + description: Successful Operation + summary: Get Elements of a tenant (v2.5) + tags: + - Device Configuration + /v2.5/api/tenants/{tenant_id}/elements/query: + post: + description: Queries db for limit number of elements that match query params. + operationId: post-v2.5-api-tenants-tenant_id-elements-query + 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/ElementQuery' + description: Queries to the element + responses: + '200': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilterV2N5' + type: array + type: object + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementAggregateQueryFilterV2N5' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + - code: UNSUPPOPRTED_REQUEST_PARAMETERS + - code: INVALID_AGGREGATE_QUERY_PARAMS + - code: INVALID_AGGREGATE_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '500': + content: + application/json: + example: + value: + _error: + - code: INVALID_SUBJECT_DATA + - code: SERVICE_UNAVAILABLE + schema: + $ref: '#/components/schemas/Error' + description: Internal Server Error + summary: Queries db for limit number of elements that match query params. (v2.5) + tags: + - Device Configuration + /v2.5/api/tenants/{tenant_id}/elements/{element_id}: + get: + description: Get Element of a tenant + operationId: get-v2.5-api-tenants-tenant_id-elements-element_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string - type: object - VffToken: - properties: - id: - description: 'The ID of the vff token. - - ' + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id type: string - ion_key: - description: 'The ION key. - - ' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementV2N5' + description: Successful Operation + summary: Get Element of a tenant (v2.5) + tags: + - Device Configuration + put: + description: Used for associations and element updates + operationId: put-v2.5-api-tenants-tenant_id-elements-element_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string - is_expired: - description: 'Is vff token expired. True or False. - - ' - type: boolean - is_multiuse: - description: 'Is the vff token multiuse. True or False. - - ' - type: boolean - is_revoked: - description: "Can the vff token be revoked. True or False. \n" - type: boolean - is_used: - description: 'Is the vff token in use. True or False. - - ' - type: boolean - secret_key: - description: 'The secret key. - - ' + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id type: string - valid_till_secs: - description: 'The token valid time in seconds. - - ' - format: int64 - type: integer - vfflicense_id: - description: 'The vff license ID. - - ' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV2N5' + description: Update to the element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV2N5' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_JSON + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_CLAIMED + - code: SITE_NOT_FOUND + - code: ELEMENT_BOUND_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Used for associations and element updates (v2.5) + tags: + - Device Configuration + /v2.6/api/tenants/{tenant_id}/elements: + get: + description: Get Elements of a tenant + operationId: get-v2.6-api-tenants-tenant_id-elements + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string - VffTokenQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of vff tokens that match the query parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number of vff tokens deleted for a time frame. - - ' - type: boolean - group_by: - description: 'Group the vff tokens for the query. - - ' - items: - description: Group By - type: string - type: array - id: - description: "List the vff tokens by ID. \n" + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementV2N6' + 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 Elements of a tenant (v2.6) + tags: + - Device Configuration + /v2.6/api/tenants/{tenant_id}/elements/query: + post: + description: Queries db for limit number of elements that match query params. + operationId: post-v2.6-api-tenants-tenant_id-elements-query + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant 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: - 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 - VffTokenQueryFilter: - properties: - id: - description: 'The ID of the vff token. - - ' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementQuery' + description: Queries to the element + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilterV2N6' + 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: Queries db for limit number of elements that match query params. (v2.6) + tags: + - Device Configuration + /v2.6/api/tenants/{tenant_id}/elements/{element_id}: + get: + description: Get Element of a tenant + operationId: get-v2.6-api-tenants-tenant_id-elements-element_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string - ion_key: - description: 'The ION key. - - ' + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id type: string - is_expired: - description: 'Is vff token expired. True or False. - - ' - type: boolean - is_multiuse: - description: 'Is the vff token multiuse. True or False. - - ' - type: boolean - is_revoked: - description: "Can the vff token be revoked. True or False. \n" - type: boolean - is_used: - description: 'Is the vff token in use. True or False. - - ' - type: boolean - secret_key: - description: 'The secret key. - - ' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementV2N6' + 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 a tenant (v2.6) + tags: + - Device Configuration + put: + description: Used for associations and element updates + operationId: put-v2.6-api-tenants-tenant_id-elements-element_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string - valid_till_secs: - description: 'The token valid time in seconds. - - ' - format: int64 - type: integer - vfflicense_id: - description: 'The vff license ID. - - ' + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id type: string - VffTokenScreen: - properties: - id: - description: 'The ID of the vff token. - - ' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV2N6' + description: Update to the element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV2N6' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_JSON + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_CLAIMED + - code: SITE_NOT_FOUND + - code: ELEMENT_BOUND_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Used for associations and element updates (v2.6) + tags: + - Device Configuration + /v2.7/api/tenants/{tenant_id}/elements: + get: + description: Get Elements of a tenant + operationId: get-v2.7-api-tenants-tenant_id-elements + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string - ion_key: - description: 'The ION key. - - ' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementV2N7' + 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 Elements of a tenant (v2.7) + tags: + - Device Configuration + /v2.7/api/tenants/{tenant_id}/elements/query: + post: + description: Queries db for limit number of elements that match query params. + operationId: post-v2.7-api-tenants-tenant_id-elements-query + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string - is_expired: - description: 'Is vff token expired. True or False. - - ' - type: boolean - is_multiuse: - description: 'Is the vff token multiuse. True or False. - - ' - type: boolean - is_revoked: - description: "Can the vff token be revoked. True or False. \n" - type: boolean - is_used: - description: 'Is the vff token in use. True or False. - - ' - type: boolean - secret_key: - description: 'The secret key. - - ' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementQuery' + description: Queries to the element + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilterV2N7' + 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: Queries db for limit number of elements that match query params. (v2.7) + tags: + - Device Configuration + /v2.7/api/tenants/{tenant_id}/elements/{element_id}: + get: + description: Get Element of a tenant + operationId: get-v2.7-api-tenants-tenant_id-elements-element_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementV2N7' + 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 a tenant (v2.7) + tags: + - Device Configuration + put: + description: Used for associations and element updates + operationId: put-v2.7-api-tenants-tenant_id-elements-element_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string - valid_till_secs: - description: 'The token valid time in seconds. - - ' - format: int64 - type: integer - vfflicense_id: - description: 'The vff license ID. - - ' + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id type: string - VlanConfig: - properties: - element_vlan_unique_id: - description: 'The element VLAN unique ID. - - ' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV2N7' + description: Update to the element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV2N7' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_JSON + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_CLAIMED + - code: SITE_NOT_FOUND + - code: ELEMENT_BOUND_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Used for associations and element updates (v2.7) + tags: + - Device Configuration + /v3.0/api/tenants/{tenant_id}/elements: + get: + description: Get the element of a tenant. + operationId: get-v3.0-api-tenants-tenant_id-elements + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string - mstp_instance: - description: Mstp Instance - format: int32 - type: integer - vlan_id: - description: 'The VLAN ID. - - ' - format: int32 - type: integer - voice_enabled: - description: 'The voice enabled VLAN. - - ' - type: boolean - X509Objects: - properties: - certHolder: - type: object - certificate: - description: Certificate + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementV3' + type: array + type: object + description: Successful Operation + summary: Get Element of Tenant (v3.0) + tags: + - Device Configuration + /v3.0/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 + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string - is_local_ca_cert_set: - description: Is Local Ca Cert Set - type: boolean - is_remote_ca_cert_set: - description: Is Remote Ca Cert Set - type: boolean - keyPair: - type: object - local_ca_certificate: - description: Local Ca Certificate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementQuery' + description: Queries to the element + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilterV3' + 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 Elements (v3.0) + tags: + - Device Configuration + /v3.0/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 + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string - local_ca_certs_set: - description: Local Ca Certs Set - items: - type: object - type: array - passphrase: - description: Passphrase + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id type: string - private_key: - description: Private Key + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementV3' + description: Successful Operation + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Element not found + summary: Get Element of Tenant (v3.0) + tags: + - Device Configuration + put: + description: Update element for associations. + operationId: put-v3.0-api-tenants-tenant_id-elements-element_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id type: string - remote_ca_certificate: - description: Remote Ca Certificate + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id type: string - remote_ca_certs_set: - description: Remote Ca Certs Set - items: - type: object - type: array -info: - contact: {} - description: List of APIs used to manage your device software to upgrade, retrieve - available software images, and upgrade status information. - title: Device Configuration - version: Latest -openapi: 3.0.0 -paths: - /v2.0/api/tenants/{tenant_id}/elements/software/state/query: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV3' + description: Update to the element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - 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: 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 + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Element for Associations (v3.0) + tags: + - Device Configuration + /v3.0/api/tenants/{tenant_id}/machines/rquery: post: - description: Query the software state for all the tenant's elements. - operationId: post-v2.0-api-tenants-tenant_id-elements-software-state-query + description: Query and get ESP machines across regions + operationId: post-v3.0-api-tenants-tenant_id-machines-rquery parameters: - - description: The tenant ID. - in: path + - in: path name: tenant_id required: true schema: @@ -8638,7 +21765,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementStateQuery' + $ref: '#/components/schemas/MachineQuery' + description: Details of machine query responses: '200': content: @@ -8649,91 +21777,60 @@ paths: - properties: items: items: - $ref: '#/components/schemas/ElementStateQueryFilter' + $ref: '#/components/schemas/MachineQuery' type: array type: object description: Successful Operation - summary: Query Software State for Tenant's Elements (v2.0) + summary: Query and get ESP machines across regions (v3.0) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/elements/{element_id}/certificate_operations: - post: - description: Start the CIC renewal process for an element device. - operationId: post-v2.0-api-tenants-tenant_id-elements-element_id-certificate_operations + /v3.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: + get: + description: Get interface status + operationId: get-v3.0-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id-status parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The element ID. + - description: Site Id in: path - name: element_id + name: site_id required: true schema: - description: Element Id + description: Site Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ElementOperations' - description: Details of the operations on element - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ElementOperations' - description: Successful Operation - summary: CIC Renewal Process for Element Device (v2.0) - tags: - - Device Configuration - /v2.0/api/tenants/{tenant_id}/elements/{element_id}/hardwarebypass: - get: - description: List all the hardware bypasses in an element. - operationId: get-v2.0-api-tenants-tenant_id-elements-element_id-hardwarebypass - parameters: - - description: The tenant ID. + - description: Element Id in: path - name: tenant_id + name: element_id required: true schema: - description: Tenant Id + description: Element Id type: string - - description: The element ID. + - description: Interface Id in: path - name: element_id + name: interface_id required: true schema: - description: Element Id + description: Interface Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HardwareBypass' + $ref: '#/components/schemas/InterfaceState' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INTERFACE_CONFIG_HWBYPASS_NOT_SUPPORTED - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Hardware Bypasses in Element (v2.0) + summary: Get interface status (v3.0) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/elements/{element_id}/operations: + /v3.1/api/tenants/{tenant_id}/machines/rquery: post: - description: Handle all the operations on an element. - operationId: post-v2.0-api-tenants-tenant_id-elements-element_id-operations + description: Query and get all MSP machines across regions. + operationId: post-v3.1-api-tenants-tenant_id-machines-rquery parameters: - description: The tenant ID. in: path @@ -8742,72 +21839,76 @@ paths: schema: description: Tenant 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/ElementOperations' - description: Details of the operations on element + $ref: '#/components/schemas/MachineQuery' + description: Details of machine query responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementOperations' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/MachineQuery' + type: array + type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: ELEMENT_NOT_FOUND - - code: COMMAND_NOT_SUPPORTED - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Handle Operations on Element (v2.0) + summary: Query MSP Machines across Regions (v3.1) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/elements/{element_id}/software/state: + /v3.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: get: - description: Get the software upgrade configuration of an element. - operationId: get-v2.0-api-tenants-tenant_id-elements-element_id-software-state + description: Get interface status + operationId: get-v3.1-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id-status parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The element ID. + - description: Site Id + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementSoftwareState' + $ref: '#/components/schemas/InterfaceStateV3N1' description: Successful Operation - summary: Get Software Upgrade Configuration of Element (v2.0) + summary: Get interface status (v3.1) tags: - Device Configuration - put: - description: Upgrade an element. - operationId: put-v2.0-api-tenants-tenant_id-elements-element_id-software-state + /v3.2/api/tenants/{tenant_id}/machines/rquery: + post: + description: Query and get all MSP machines across regions. + operationId: post-v3.2-api-tenants-tenant_id-machines-rquery parameters: - description: The tenant ID. in: path @@ -8816,157 +21917,162 @@ paths: schema: description: Tenant 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/ElementSoftwareStateScreen' + $ref: '#/components/schemas/MachineQuery' + description: Details of machine query responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementSoftwareState' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/MachineQuery' + type: array + type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SOFTWARE_CONFIG_INVALID_SCHEDULING - - code: SOFTWARE_CONFIG_SCHEDULED_UPGRADE_NOT_SUPPORTED - - code: SOFTWARE_CONFIG_INVALID_DOWNLOAD_INTERVAL - - code: SOFTWARE_CONFIG_INVALID_UPGRADE_INTERVAL - - code: SOFTWARE_CONFIG_INVALID_DOWNLOAD_TIME - - code: SOFTWARE_CONFIG_INVALID_UPGRADE_TIME - - code: SOFTWARE_CONFIG_INCOMPATIBLE_SCHEDULES - - code: SOFTWARE_CONFIG_INVALID_INTERFACES - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Upgrade an Element (v2.0) + summary: Query MSP Machines across Regions (v3.2) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/elements/{element_id}/software/status: + /v3.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: get: - description: Get the image status. - operationId: get-v2.0-api-tenants-tenant_id-elements-element_id-software-status + description: Get element interfacestate + operationId: get-v3.2-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id-status parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The element ID. + - description: Site Id + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementImageStatus' + $ref: '#/components/schemas/InterfaceStateV3N2' description: Successful Operation - summary: Get Image Status (v2.0) + summary: Get element interface state (v3.2) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/elements/{element_id}/state: + /v3.3/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: get: - description: Get the element state. - operationId: get-v2.0-api-tenants-tenant_id-elements-element_id-state + description: Get element interfacestate + operationId: get-v3.3-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id-status parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The element ID. + - description: Site Id + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementState' + $ref: '#/components/schemas/InterfaceStateV3N3' description: Successful Operation - summary: Get Element State (v2.0) + summary: Get element interface state (v3.3) tags: - Device Configuration - put: - description: Update the element state. - operationId: put-v2.0-api-tenants-tenant_id-elements-element_id-state + /v3.4/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 parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The element ID. + - description: Site Id + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ElementStateScreen' - description: Update element state + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementState' + $ref: '#/components/schemas/InterfaceStateV3N4' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: ELEMENT_NOT_FOUND - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: ELEMENT_BOUND_ERROR - - code: ELEMENT_CONFIG_INVALID_VALUES - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Element State (v2.0) + summary: Get interface status (v3.4) 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 + /v3.5/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 parameters: - description: The tenant ID. in: path @@ -8975,112 +22081,116 @@ paths: schema: description: Tenant Id type: string - - description: The machine ID. + - description: The site ID. in: path - name: machine_id + name: site_id required: true schema: - description: Machine Id + 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MachineV2N5' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineV2N5' + $ref: '#/components/schemas/InterfaceStateV3N5' 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) + summary: Get Interface Status (v3.5) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/admin_state: - put: - description: Update admin state Northbound. - operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-admin_state + /v4.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: + get: + description: Get all element interfaces + operationId: get-v4.0-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Element' - description: Update admin state responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Element' + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/InterfaceV4N1' + type: array + type: object description: Successful Operation - summary: Update Admin State Northbound (v2.0) + summary: Get all element interfaces (v4.0) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/application_probe: - get: - description: Get the application probe configuration of an element. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-application_probe + post: + description: Create an element logical interface + operationId: post-v4.0-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceScreenV4N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ApplicationProbe' + $ref: '#/components/schemas/InterfaceV4N1' description: Successful Operation '400': content: @@ -9088,50 +22198,56 @@ paths: example: value: _error: - - code: APPLICATION_PROBE_CONFIG_UNSUPPORTED_SWVERSION - - code: APPLICATION_PROBE_CONFIG_NOT_PRESENT + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Application Probe Configuration (v2.0) + summary: Create an element logical interface (v4.0) tags: - Device Configuration - put: - description: Update the application probe configuration of an element. - operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-application_probe + /v4.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an element interface + operationId: delete-v4.0-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ApplicationProbeScreen' + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ApplicationProbe' + $ref: '#/components/schemas/InterfaceV4N1' description: Successful Operation '400': content: @@ -9139,101 +22255,98 @@ paths: example: value: _error: - - code: APPLICATION_PROBE_CONFIG_UNSUPPORTED_SWVERSION - - code: APPLICATION_PROBE_CONFIG_UNSUPPORTED_ROLE - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: APPLICATION_PROBE_CONFIG_INVALID_SOURCE_INTERFACE + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Application Probe Configuration (v2.0) + summary: Delete an element interface (v4.0) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/extensions: get: - description: List all the element level extensions. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-extensions + description: Get element interface details + operationId: get-v4.0-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string responses: '200': content: application/json: schema: - oneOf: - - $ref: '#/components/schemas/ListQueryResponse' - - $ref: '#/components/schemas/ListResponse' + $ref: '#/components/schemas/InterfaceV4N1' 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 Element Level Extensions (v2.0) + summary: Get element interface details (v4.0) tags: - Device Configuration - post: - description: Create an element level extension configuration. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-extensions + put: + description: Provision an element interface + operationId: put-v4.0-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExtensionScreen' + $ref: '#/components/schemas/InterfaceScreenV4N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: '#/components/schemas/InterfaceV4N1' description: Successful Operation '400': content: @@ -9241,118 +22354,100 @@ paths: example: value: _error: + - code: INTERFACE_NOT_FOUND - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: SITE_NOT_FOUND - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: INVALID_JSON_INPUT - - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Element Level Extension Configuration (v2.0) + summary: Provision an element interface (v4.0) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/extensions/query: - post: - description: Query element level extensions that match query parameters. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-extensions-query + /v4.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: + get: + description: Get all element interfaces + operationId: get-v4.1-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ExtensionQuery' responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - $ref: '#/components/schemas/ExtensionQuery' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: SITE_NOT_FOUND - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: INVALID_JSON_INPUT - - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Element Level Extensions (v2.0) + $ref: '#/components/schemas/InterfaceV4N1' + type: array + type: object + description: Successful Operation + summary: Get all element interfaces (v4.1) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/extensions/{extension_id}: - delete: - description: Delete a specific extension associated with an element. - operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-extensions-extension_id + post: + description: Create an element logical interface + operationId: post-v4.1-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string - - description: The extension ID. - in: path - name: extension_id - required: true - schema: - description: Extension Id - type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceScreenV4N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: '#/components/schemas/InterfaceV4N1' description: Successful Operation '400': content: @@ -9360,51 +22455,56 @@ paths: example: value: _error: - - code: EXTENSION_NOT_FOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Element Level Extension (v2.0) + summary: Create an element logical interface (v4.1) tags: - Device Configuration - get: - description: Get a specific extension associated with an element. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-extensions-extension_id + /v4.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an element interface + operationId: delete-v4.1-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string - - description: The extension ID. + - description: Interface Id in: path - name: extension_id + name: interface_id required: true schema: - description: Extension Id + description: Interface Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: '#/components/schemas/InterfaceV4N1' description: Successful Operation '400': content: @@ -9412,56 +22512,51 @@ paths: example: value: _error: - - code: EXTENSION_NOT_FOUND + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Element Level Extension (v2.0) + summary: Delete an element interface (v4.1) tags: - Device Configuration - put: - description: Update an element level extension configuration. - operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-extensions-extension_id + get: + description: Get element interface details + operationId: get-v4.1-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string - - description: The extension ID. + - description: Interface Id in: path - name: extension_id + name: interface_id required: true schema: - description: Extension Id + description: Interface Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ExtensionScreen' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: '#/components/schemas/InterfaceV4N1' description: Successful Operation '400': content: @@ -9469,87 +22564,56 @@ paths: example: value: _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_INPUT - - code: EXTENSION_NOT_FOUND - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Element Level Extension (v2.0) + summary: Get element interface details (v4.1) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/extensions: - get: - description: List all the site level extensions. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-extensions + put: + description: Provision an element interface + operationId: put-v4.1-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - responses: - '200': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/ListQueryResponse' - - $ref: '#/components/schemas/ListResponse' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Site Level Extensions (v2.0) - tags: - - Device Configuration - post: - description: Create site level extension configuration. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-extensions - parameters: - - description: The tenant ID. + - description: Element Id in: path - name: tenant_id + name: element_id required: true schema: - description: Tenant Id + description: Element Id type: string - - description: The site ID. + - description: Interface Id in: path - name: site_id + name: interface_id required: true schema: - description: Site Id + description: Interface Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExtensionScreen' + $ref: '#/components/schemas/InterfaceScreenV4N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: '#/components/schemas/InterfaceV4N1' description: Successful Operation '400': content: @@ -9557,41 +22621,38 @@ paths: example: value: _error: + - code: INTERFACE_NOT_FOUND - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: SITE_NOT_FOUND - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: INVALID_JSON_INPUT - - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Site Level Extension Configuration (v2.0) + summary: Provision an element interface (v4.1) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/extensions/query: + /v4.10/api/tenants/{tenant_id}/interfaces/query: post: - description: Query site level extensions that match query parameters. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-extensions-query + description: Queries db for limit number of interfaces that match query params. + operationId: post-v4.10-api-tenants-tenant_id-interfaces-query parameters: - - description: The tenant ID. + - description: 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/ExtensionQuery' + $ref: '#/components/schemas/BaseQuery' responses: '200': content: @@ -9602,90 +22663,93 @@ paths: - properties: items: items: - $ref: '#/components/schemas/ExtensionQuery' + $ref: '#/components/schemas/InterfaceQueryResponseV4N10' type: array type: object description: Successful Operation - summary: Query Site Level Extension (v2.0) + summary: Queries db for limit number of interfaces that match query params. + (v4.10) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/extensions/{extension_id}: - delete: - description: Delete a specific extension associated with a site. - operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-extensions-extension_id + /v4.10/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: + get: + description: Get all Interfaces + operationId: get-v4.10-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The extension ID. + - description: Element Id in: path - name: extension_id + name: element_id required: true schema: - description: Extension Id + description: Element Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/InterfaceV4N10' + type: array + type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: EXTENSION_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Site Level Extension (v2.0) + summary: Get all Interfaces (v4.10) tags: - Device Configuration - get: - description: Get a specific extension associated with a site. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-extensions-extension_id + post: + description: Create a Interface + operationId: post-v4.10-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The extension ID. + - description: Element Id in: path - name: extension_id + name: element_id required: true schema: - description: Extension Id + description: Element Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceScreenV4N10' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: '#/components/schemas/InterfaceV4N10' description: Successful Operation '400': content: @@ -9693,119 +22757,168 @@ paths: example: value: _error: - - code: EXTENSION_NOT_FOUND + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_TYPE_UPDATE_NOT_ALLOWED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Site Level Extension (v2.0) + summary: Create a Interface (v4.10) tags: - Device Configuration - put: - description: Update a specific extension configuration associated with a site. - operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-extensions-extension_id + /v4.10/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete Interface + operationId: delete-v4.10-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The extension ID. + - description: Element Id in: path - name: extension_id + name: element_id required: true schema: - description: Extension Id + description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ExtensionScreen' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Extension' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_INPUT - - code: EXTENSION_NOT_FOUND - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string + responses: + '200': + content: + application/json: schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Site Level Extension Configuration (v2.0) + $ref: '#/components/schemas/InterfaceV4N10' + description: Successful Operation + summary: Delete Interface (v4.10) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/vfflicenses: get: - description: List all the Vff license for a tenant. - operationId: get-v2.0-api-tenants-tenant_id-vfflicenses + description: Get Interface + operationId: get-v4.10-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/VffLicense' - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N10' description: Successful Operation - summary: Get Vff License for Tenant (v2.0) + summary: Get Interface (v4.10) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/vfflicenses/rquery: - post: - description: Query to get the virtual device(vff) license. - operationId: post-v2.0-api-tenants-tenant_id-vfflicenses-rquery + put: + description: Update a Interface + operationId: put-v4.10-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/VffLicenseQuery' + $ref: '#/components/schemas/InterfaceScreenV4N10' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VffLicenseQuery' + $ref: '#/components/schemas/InterfaceV4N10' description: Successful Operation '400': content: @@ -9813,20 +22926,44 @@ paths: example: value: _error: + - code: INVALID_JSON_INPUT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_MODEL + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query and Get Vff License (v2.0) + summary: Update a Interface (v4.10) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/vfflicenses/tokens/query: + /v4.11/api/tenants/{tenant_id}/interfaces/query: post: - description: Query all the tenant Vff license tokens. - operationId: post-v2.0-api-tenants-tenant_id-vfflicenses-tokens-query + description: Queries db for limit number of interfaces that match query params. + operationId: post-v4.11-api-tenants-tenant_id-interfaces-query parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true @@ -9837,148 +22974,98 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VffTokenQuery' + $ref: '#/components/schemas/BaseQuery' responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/VffTokenQueryFilter' + $ref: '#/components/schemas/BaseQuery' type: array type: object description: Successful Operation - summary: Query Vff License Tokens (v2.0) + summary: Queries db for limit number of interfaces that match query params. + (v4.11) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/vfflicenses/{license_id}: + /v4.11/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: get: - description: List all the specific Vff licenses for a tenant. - operationId: get-v2.0-api-tenants-tenant_id-vfflicenses-license_id + description: Get all Interfaces + operationId: get-v4.11-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces 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. - in: path - name: license_id - required: true - schema: - description: License Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/VffLicense' - description: Successful Operation - summary: Get Vff Licenses for Tenant (v2.0) - tags: - - Device Configuration - /v2.0/api/tenants/{tenant_id}/vfflicenses/{license_id}/operations: - post: - description: 'List the vff operations. - - ' - operationId: post-v2.0-api-tenants-tenant_id-vfflicenses-license_id-operations - parameters: - - description: Tenant Id + - description: Site Id in: path - name: tenant_id + name: site_id required: true schema: - description: Tenant Id + description: Site Id type: string - - description: License Id + - description: Element Id in: path - name: license_id + name: element_id required: true schema: - description: License Id + description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VffOperationInfo' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VffLicenseV2' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/InterfaceV4N11' + type: array + type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_CHILD_TENANT - - code: INVALID_VFF_LICENSE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Vff Operation (v2.0) + summary: Get all Interfaces (v4.11) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/vfflicenses/{license_id}/status: - get: - description: List the status for the Vff license. - operationId: get-v2.0-api-tenants-tenant_id-vfflicenses-license_id-status + post: + description: Create a Interface + operationId: post-v4.11-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces 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. - in: path - name: license_id - required: true - schema: - description: License Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/VffLicenseState' - description: Successful Operation - summary: Get Status for Vff License (v2.0) - tags: - - Device Configuration - /v2.0/api/tenants/{tenant_id}/vfflicenses/{license_id}/tokens: - get: - description: List all the tenant Vff license tokens. - operationId: get-v2.0-api-tenants-tenant_id-vfflicenses-license_id-tokens - parameters: - - description: The tenant ID. + - description: Site Id in: path - name: tenant_id + name: site_id required: true schema: - description: Tenant Id + description: Site Id type: string - - description: The license ID. + - description: Element Id in: path - name: license_id + name: element_id required: true schema: - description: License Id + description: Element Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceScreenV4N11' responses: '200': content: @@ -9989,132 +23076,179 @@ paths: - properties: items: items: - $ref: '#/components/schemas/VffToken' + $ref: '#/components/schemas/InterfaceV4N11' type: array type: object description: Successful Operation - summary: Get Tenant Vff License Tokens (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_TYPE_UPDATE_NOT_ALLOWED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_CREATE_NOT_SUPPORTED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create a Interface (v4.11) tags: - Device Configuration - post: - description: Create a tenant Vff license token. - operationId: post-v2.0-api-tenants-tenant_id-vfflicenses-license_id-tokens + /v4.11/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete Interface + operationId: delete-v4.11-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id 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: Site Id in: path - name: license_id + name: site_id required: true schema: - description: License Id + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VffToken' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VffToken' + $ref: '#/components/schemas/InterfaceV4N11' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: TOKEN_CONFIG_INVALID_POST_VALUES - - code: LICENSE_UNKNOWN - - code: ION_MAX_LIMIT - - code: ERROR_IN_TOKEN_GENERATION - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Tenant Vff License Token (v2.0) + summary: Delete Interface (v4.11) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/vfflicenses/{license_id}/tokens/{token_id}: get: - description: List a specific tenant Vff license token. - operationId: get-v2.0-api-tenants-tenant_id-vfflicenses-license_id-tokens-token_id + description: Get Interface + operationId: get-v4.11-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id 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: Site Id in: path - name: license_id + name: site_id required: true schema: - description: License Id + description: Site Id type: string - - description: The token ID. + - description: Element Id in: path - name: token_id + name: element_id required: true schema: - description: Token Id + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VffToken' + $ref: '#/components/schemas/InterfaceV4N11' description: Successful Operation - summary: Get Tenant Vff License Token (v2.0) + summary: Get Interface (v4.11) tags: - Device Configuration put: - description: Update a specific tenant Vff license token. - operationId: put-v2.0-api-tenants-tenant_id-vfflicenses-license_id-tokens-token_id + description: Update a Interface + operationId: put-v4.11-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id 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: Site Id in: path - name: license_id + name: site_id required: true schema: - description: License Id + description: Site Id type: string - - description: The token ID. + - description: Element Id in: path - name: token_id + name: element_id required: true schema: - description: Token Id + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/VffTokenScreen' + $ref: '#/components/schemas/InterfaceScreenV4N11' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VffToken' + $ref: '#/components/schemas/InterfaceV4N11' description: Successful Operation '400': content: @@ -10122,20 +23256,67 @@ paths: example: value: _error: + - code: INVALID_JSON_INPUT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: TOKEN_CONFIG_INVALID_PUT_VALUES + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED + - code: CELLULAR_INTERFACE_TYPE_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_CANNOT_BE_NULL + - code: CELLULAR_INTERFACE_PARENT_MODULE_ID_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_PARENT_SIM_SLOT_NUMBER_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_SITEWAN_NUMBER + - code: CELLULAR_INTERFACE_CONFIG_HARDWARE_RELAY_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_USED_FOR_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_INTERNET + - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_WAN + - code: CELLULAR_INTERFACE_CONFIG_MTU_INVALID + - code: CELLULAR_INTERFACE_CONFIG_DHCP_RELAY_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_LANSTATE_PROPOGATION_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILEID_INVALID_WHEN_AUTOAPN + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_APNPROFILEID_PRESENT + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_NO_USERNAME_BUT_PWD_EXISTS + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_MISSING_WHEN_AUTOAPN_FALSE_APNPROFILEID_NULL + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_INVALID_AUTH + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_MISSING_APN_NAME + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PROFILE_NAME_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILE_ID_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PASSWORD_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_USERNAME_INVALID schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Vff License Token (v2.0) + summary: Update a Interface (v4.11) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/vfflicensesstatus/rquery: + /v4.12/api/tenants/{tenant_id}/interfaces/query: post: - description: Query to get the license state of the virtual device (vff). - operationId: post-v2.0-api-tenants-tenant_id-vfflicensesstatus-rquery + description: Queries db for limit number of interfaces that match query params. + operationId: post-v4.12-api-tenants-tenant_id-interfaces-query parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true @@ -10146,146 +23327,109 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VffLicenseStateQuery' + $ref: '#/components/schemas/BaseQuery' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VffLicenseStateQuery' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BaseQuery' + type: array + type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_MODEL - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query to Get Vff License State (v2.0) + summary: Queries db for limit number of interfaces that match query params. + (v4.12) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/ws/extensions: + /v4.12/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: get: - description: List all the extensions from NB. - operationId: get-v2.0-api-tenants-tenant_id-ws-extensions + description: Get all Interfaces + operationId: get-v4.12-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - responses: - '200': - content: - application/json: - schema: - oneOf: - - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/Extension' - type: array - type: object - - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/ExtensionQueryFilter' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: EXTENSION_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Extensions from NB (v2.0) - tags: - - Device Configuration - post: - description: Create an extension configuration. - operationId: post-v2.0-api-tenants-tenant_id-ws-extensions - parameters: - - description: The tenant ID. + - description: Site Id in: path - name: tenant_id + name: site_id required: true schema: - description: Tenant Id + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Extension' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/InterfaceV4N12' + type: array + type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: EXTENSION_NAME_REQD - - code: INVALID_EXTENSION_CONF - - code: INVALID_EXTENSION_NAMESPACE - - code: EXTENSION_NAMESPACE_REQD - - code: INVALID_EXTENSION_NAME - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Extension Configuration (v2.0) + summary: Get all Interfaces (v4.12) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/ws/extensions/query: post: - description: Query the DB for limit number of tenant extensions that match the - query params. - operationId: post-v2.0-api-tenants-tenant_id-ws-extensions-query + description: Create a Interface + operationId: post-v4.12-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExtensionQuery' + $ref: '#/components/schemas/InterfaceScreenV4N12' responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/ExtensionQueryFilter' + $ref: '#/components/schemas/InterfaceV4N12' type: array type: object description: Successful Operation @@ -10295,114 +23439,173 @@ paths: example: value: _error: - - code: INVALID_REQUEST_ERROR_0001 + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_TYPE_UPDATE_NOT_ALLOWED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_CREATE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_INVALID_MULTICAST_IGMP_VALUE + - code: INTERFACE_CONFIG_INVALID_MULTICAST_IGMP_STATIC_SRC_IPV4 + - code: INTERFACE_CONFIG_INVALID_MULTICAST_IGMP_STATIC_GRP_IPV4 + - code: INTERFACE_CONFIG_INVALID_MULTICAST_DR_PRIORITY schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Tenant Extensions (v2.0) + summary: Create a Interface (v4.12) tags: - Device Configuration - /v2.0/api/tenants/{tenant_id}/ws/extensions/{extension_id}: + /v4.12/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: delete: - description: Delete a specific extension configuration. - operationId: delete-v2.0-api-tenants-tenant_id-ws-extensions-extension_id + description: Delete Interface + operationId: delete-v4.12-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The extension ID. + - description: Site Id in: path - name: extension_id + name: site_id required: true schema: - description: Extension Id + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: '#/components/schemas/InterfaceV4N12' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: EXTENSION_NAME_REQD - - code: INVALID_EXTENSION_CONF - - code: INVALID_EXTENSION_NAMESPACE - - code: EXTENSION_NAMESPACE_REQD - - code: INVALID_EXTENSION_NAME - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Extensions Configuration (v2.0) + summary: Delete Interface (v4.12) tags: - Device Configuration get: - description: Get a specific extension configuration from the NB. - operationId: get-v2.0-api-tenants-tenant_id-ws-extensions-extension_id + description: Get Interface + operationId: get-v4.12-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The extension ID. + - description: Site Id in: path - name: extension_id + name: site_id required: true schema: - description: Extension Id + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: '#/components/schemas/InterfaceV4N12' description: Successful Operation - summary: Get Extensions Configuration from NB (v2.0) + summary: Get Interface (v4.12) tags: - Device Configuration put: - description: Update a specific extension configuration. - operationId: put-v2.0-api-tenants-tenant_id-ws-extensions-extension_id + description: Update a Interface + operationId: put-v4.12-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The extension ID. + - description: Site Id in: path - name: extension_id + name: site_id required: true schema: - description: Extension Id + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: '#/components/schemas/InterfaceScreenV4N12' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: '#/components/schemas/InterfaceV4N12' description: Successful Operation '400': content: @@ -10410,32 +23613,160 @@ paths: example: value: _error: + - code: INVALID_JSON_INPUT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: EXTENSION_NAME_REQD - - code: INVALID_EXTENSION_CONF - - code: INVALID_EXTENSION_NAMESPACE - - code: EXTENSION_NAMESPACE_REQD - - code: INVALID_EXTENSION_NAME + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED + - code: CELLULAR_INTERFACE_TYPE_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_CANNOT_BE_NULL + - code: CELLULAR_INTERFACE_PARENT_MODULE_ID_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_PARENT_SIM_SLOT_NUMBER_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_SITEWAN_NUMBER + - code: CELLULAR_INTERFACE_CONFIG_HARDWARE_RELAY_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_USED_FOR_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_INTERNET + - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_WAN + - code: CELLULAR_INTERFACE_CONFIG_MTU_INVALID + - code: CELLULAR_INTERFACE_CONFIG_DHCP_RELAY_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_LANSTATE_PROPOGATION_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILEID_INVALID_WHEN_AUTOAPN + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_APNPROFILEID_PRESENT + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_NO_USERNAME_BUT_PWD_EXISTS + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_MISSING_WHEN_AUTOAPN_FALSE_APNPROFILEID_NULL + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_INVALID_AUTH + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_MISSING_APN_NAME + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PROFILE_NAME_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILE_ID_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PASSWORD_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_USERNAME_INVALID + - code: INTERFACE_CONFIG_INVALID_MULTICAST_IGMP_VALUE + - code: INTERFACE_CONFIG_INVALID_MULTICAST_IGMP_STATIC_SRC_IPV4 + - code: INTERFACE_CONFIG_INVALID_MULTICAST_IGMP_STATIC_GRP_IPV4 + - code: INTERFACE_CONFIG_INVALID_MULTICAST_DR_PRIORITY schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Extensions Configuration (v2.0) + summary: Update a Interface (v4.12) tags: - Device Configuration - /v2.1/api/tenants/{tenant_id}/elements/{element_id}/fips_mode_change_operations: + /v4.13/api/tenants/{tenant_id}/interfaces/query: post: - description: Change the mode of an element from FIPS to Non-FIPS or vice-versa. - operationId: post-v2.1-api-tenants-tenant_id-elements-element_id-fips_mode_change_operations + description: Queries db for limit number of interfaces that match query params. + operationId: post-v4.13-api-tenants-tenant_id-interfaces-query parameters: - - description: The tenant ID. + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: null + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BaseQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BaseQuery' + type: array + type: object + description: Successful Operation + summary: Queries db for limit number of interfaces that match query params. + (v4.13) + tags: + - Device Configuration + /v4.13/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: + get: + description: Get all Interfaces + operationId: get-v4.13-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces + parameters: + - description: Tenant Id + 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 + 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/InterfaceV4N13' + type: array + type: object + description: Successful Operation + summary: Get all Interfaces (v4.13) + tags: + - Device Configuration + post: + description: Create a Interface + operationId: post-v4.13-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces + parameters: + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The element ID. + - description: Site Id + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: Element Id in: path name: element_id required: true @@ -10446,14 +23777,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementOperations' - description: Details of the operations on element + $ref: '#/components/schemas/InterfaceScreenV4N13' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementOperations' + $ref: '#/components/schemas/InterfaceV4N13' description: Successful Operation '400': content: @@ -10461,83 +23791,98 @@ paths: example: value: _error: + - code: INVALID_JSON_INPUT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: FIPS_MODE_INVALID_OPERATION - - code: ELEMENT_NOT_FOUND - - code: ELEMENT_NOT_CONNECTED - - code: FIPS_MODE_ELEMENT_ALREADY_IN_REQUESTED_MODE - - code: FIPS_MODE_MODEL_NOT_SUPPORTED - - code: FIPS_MODE_FORBIDDEN_INVALID_STATE - - code: FIPS_MODE_CHANGE_NOT_SUPPORTED - - code: FIPS_MODE_PLEASE_RETRY_LATER + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_TYPE_UPDATE_NOT_ALLOWED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_CREATE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_CREATE_NOT_SUPPORTED + - 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 + - code: INTERFACE_CONFIG_VLAN_INVALID_USED_FOR_NOTSUPPORTED + - code: INTERFACE_CONFIG_VLAN_TYPE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_VLAN_INVALID_VLAN_ID + - code: INTERFACE_CONFIG_VLAN_INVALID_DUPLICATE_VLAN_ID + - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_NULL + - code: INTERFACE_CONFIG_VLAN_INVALID_MSTP_INSTANCE + - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_MAX_LENGTH + - 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 schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Change Mode of Element from FIPS to Non-FIPS (v2.1) + summary: Create a Interface (v4.13) tags: - Device Configuration - /v2.1/api/tenants/{tenant_id}/elements/{element_id}/software/status: - get: - description: List all the software upgrade status (up to 5) started by the tenant - user. - operationId: get-v2.1-api-tenants-tenant_id-elements-element_id-software-status + /v4.13/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete Interface + operationId: delete-v4.13-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The element ID. + - description: Site Id in: path - name: element_id + name: site_id required: true schema: - description: Element Id + description: Site Id type: string - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/BulkResponse' - - properties: - items: - items: - $ref: '#/components/schemas/ElementImageStatusV2N1' - type: array - type: object - description: Successful Operation - summary: Get Software Upgrade Status (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. - operationId: get-v2.1-api-tenants-tenant_id-machines-machine_id-machinesystemstatus - parameters: - - description: The tenant ID. + - description: Element Id in: path - name: tenant_id + name: element_id required: true schema: - description: Tenant Id + description: Element Id type: string - - description: The machine ID. + - description: Interface Id in: path - name: machine_id + name: interface_id required: true schema: - description: Machine Id + description: Interface Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineSystemStatusV2N1' + $ref: '#/components/schemas/InterfaceV4N13' description: Successful Operation '400': content: @@ -10545,73 +23890,101 @@ paths: example: value: _error: - - code: MACHINE_UNKNOWN - - code: MACHINE_STATUS_UNKNOWN + - code: CELLULAR_INTERFACE_CONFIG_DELETE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_DELETE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_VLAN_CONFIG_IN_USE_DELETE_UNSUPPORTED + - code: INTERFACE_CONFIG_VLAN_CONFIG_DEFAULT_VLAN_DELETE_UNSUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Machine System Status (v2.1) + summary: Delete Interface (v4.13) tags: - Device Configuration - /v2.1/api/tenants/{tenant_id}/machines/{machine_id}/recovery_tokens: get: - description: Get the recovery token for a machine. - operationId: get-v2.1-api-tenants-tenant_id-machines-machine_id-recovery_tokens + description: Get Interface + operationId: get-v4.13-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The machine ID. + - description: Site Id in: path - name: machine_id + name: site_id required: true schema: - description: Machine Id + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RecoveryToken' + $ref: '#/components/schemas/InterfaceV4N13' description: Successful Operation - summary: Get Recovery Token for Machine (v2.1) + summary: Get Interface (v4.13) tags: - Device Configuration - post: - description: Create a recovery token for the FIPs change mode. - operationId: post-v2.1-api-tenants-tenant_id-machines-machine_id-recovery_tokens + put: + description: Update a Interface + operationId: put-v4.13-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The machine ID. + - description: Site Id in: path - name: machine_id + name: site_id required: true schema: - description: Machine Id + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/RecoveryTokenScreen' - description: Details of the recovery token for the element + $ref: '#/components/schemas/InterfaceScreenV4N13' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RecoveryToken' + $ref: '#/components/schemas/InterfaceV4N13' description: Successful Operation '400': content: @@ -10619,131 +23992,214 @@ paths: example: value: _error: - - code: MACHINE_NOT_FOUND - - code: FIPS_MODE_ERROR_IN_TOKEN_GENERATION + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED + - code: CELLULAR_INTERFACE_TYPE_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_CANNOT_BE_NULL + - code: CELLULAR_INTERFACE_PARENT_MODULE_ID_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_PARENT_SIM_SLOT_NUMBER_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_SITEWAN_NUMBER + - code: CELLULAR_INTERFACE_CONFIG_HARDWARE_RELAY_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_USED_FOR_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_INTERNET + - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_WAN + - code: CELLULAR_INTERFACE_CONFIG_MTU_INVALID + - code: CELLULAR_INTERFACE_CONFIG_DHCP_RELAY_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_LANSTATE_PROPOGATION_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILEID_INVALID_WHEN_AUTOAPN + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_APNPROFILEID_PRESENT + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_NO_USERNAME_BUT_PWD_EXISTS + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_MISSING_WHEN_AUTOAPN_FALSE_APNPROFILEID_NULL + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_INVALID_AUTH + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_MISSING_APN_NAME + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PROFILE_NAME_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILE_ID_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PASSWORD_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_USERNAME_INVALID + - 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 + - code: INTERFACE_CONFIG_VLAN_INVALID_USED_FOR_NOTSUPPORTED + - code: INTERFACE_CONFIG_VLAN_TYPE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_VLAN_INVALID_VLAN_ID + - code: INTERFACE_CONFIG_VLAN_INVALID_DUPLICATE_VLAN_ID + - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_NULL + - code: INTERFACE_CONFIG_SWITCH_PORT_API_UNSUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_NOT_SUPPORTED_ON_ELEMENT + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_USED_FOR_NOTSUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_NETWORK_CONTEXT_NOTSUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_SCOPE_NOTSUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_ACCESS_MISSING_VLANID_ACCESS_OR_VOICE + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_ACCESS_TRUNK_OR_NATIVE_VLANID_NOT_APPLICABLE + - code: INTERFACE_CONFIG_SWITCH_PORT_ACCESS_VLANID_NOT_FOUND + - code: INTERFACE_CONFIG_SWITCH_PORT_VOICE_VLANID_NOT_FOUND + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_MISSING_VLAN_ID_TRUNK_OR_NATIVE + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_ACCESS_OR_VOICE_VLANID_NOT_APPLICABLE + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_NATIVE_VLANID_NOT_FOUND + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_TRUNK_VLANID_NOT_FOUND + - code: INTERFACE_CONFIG_SWITCH_PORT_TRUNK_VLANID_INVALID + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_MAC_AUTH_TYPE + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_MISSING_WHEN_VLANID_PRESENT + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_REAUTH_TIMEOUT + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_STP_PRIORITY + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_STP_COST + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_IPCONFIG_NOTSUPPORTED + - code: SWITCH_PORT_INTERFACE_CONFIG_CANNOT_BE_NULL + - code: SVI_INTERFACE_TYPE_UPDATE_NOT_ALLOWED + - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_UPDATED + - code: INTERFACE_CONFIG_VLAN_INVALID_MSTP_INSTANCE + - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_MAX_LENGTH + - 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 schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Recovery Token for FIPs (v2.1) + summary: Update a Interface (v4.13) tags: - Device Configuration - /v2.1/api/tenants/{tenant_id}/machines/{machine_id}/recovery_tokens/{token_id}: - put: - description: Update a recovery token for the FIPs change mode. - operationId: put-v2.1-api-tenants-tenant_id-machines-machine_id-recovery_tokens-token_id + /v4.14/api/tenants/{tenant_id}/interfaces/query: + post: + description: Queries db for limit number of interfaces that match query params. + operationId: post-v4.14-api-tenants-tenant_id-interfaces-query parameters: - - description: The tenant ID. + - description: 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 - - description: The token ID. - in: path - name: token_id - required: true - schema: - description: Token Id - type: string + schema: null requestBody: content: application/json: schema: - $ref: '#/components/schemas/RecoveryTokenScreen' - description: Details of the recovery token for the element + $ref: '#/components/schemas/BaseQuery' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RecoveryToken' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BaseQuery' + type: array + type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: MACHINE_NOT_FOUND - - code: TOKEN_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Recovery Token for FIPs (v2.1) + summary: Queries db for limit number of interfaces that match query params. + (v4.14) tags: - Device Configuration - /v2.1/api/tenants/{tenant_id}/software/current_status/query: - post: - description: Get the current image status of all the elements. - operationId: post-v2.1-api-tenants-tenant_id-software-current_status-query + /v4.14/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 parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ElementImageStatusQuery' + - description: Site Id + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/ElementImageStatusQueryFilterV2N1' + $ref: '#/components/schemas/InterfaceV4N14' type: array type: object description: Successful Operation - summary: Get Image Status of Element (v2.1) + summary: Get all Cellular Interfaces (v4.14) tags: - Device Configuration - /v2.1/api/tenants/{tenant_id}/software/status/query: post: - description: Query the software upgrade status of all the tenant elements. - operationId: post-v2.1-api-tenants-tenant_id-software-status-query + description: Create a Interface + operationId: post-v4.14-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ElementImageStatusQuery' + $ref: '#/components/schemas/InterfaceScreenV4N14' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/ElementImageStatusQueryFilterV2N1' - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N14' description: Successful Operation '400': content: @@ -10751,132 +24207,98 @@ paths: example: value: _error: - - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_INPUT - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_TYPE_UPDATE_NOT_ALLOWED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_CREATE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_CREATE_NOT_SUPPORTED + - 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 + - code: INTERFACE_CONFIG_VLAN_INVALID_USED_FOR_NOTSUPPORTED + - code: INTERFACE_CONFIG_VLAN_TYPE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_VLAN_INVALID_VLAN_ID + - code: INTERFACE_CONFIG_VLAN_INVALID_DUPLICATE_VLAN_ID + - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_NULL + - code: INTERFACE_CONFIG_VLAN_INVALID_MSTP_INSTANCE + - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_MAX_LENGTH + - 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 schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Software Upgrade Status (v2.1) - tags: - - Device Configuration - /v2.1/api/tenants/{tenant_id}/vfflicenses: - get: - description: List all the Vff licenses for a tenant. - operationId: get-v2.1-api-tenants-tenant_id-vfflicenses - 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/VffLicenseV2' - type: array - type: object - description: Successful Operation - summary: Get Vff Licenses for Tenant (v2.1) + summary: Create a Interface (v4.14) tags: - Device Configuration - /v2.1/api/tenants/{tenant_id}/vfflicenses/{license_id}: - get: - description: List all the specific Vff licenses for a tenant. - operationId: get-v2.1-api-tenants-tenant_id-vfflicenses-license_id + /v4.14/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete Cellular Interface + operationId: delete-v4.14-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id 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. - in: path - name: license_id - required: true - schema: - 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. + - description: Site Id in: path - name: tenant_id + name: site_id required: true schema: - description: Tenant Id + description: Site Id type: string - - description: The license ID. + - description: 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' - 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. + - description: Interface Id in: path - name: tenant_id + name: interface_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: Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceV4N14' description: Successful Operation '400': content: @@ -10884,84 +24306,101 @@ paths: example: value: _error: - - code: ELEMENT_STATUS_NOT_FOUND + - code: CELLULAR_INTERFACE_CONFIG_DELETE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_DELETE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_VLAN_CONFIG_IN_USE_DELETE_UNSUPPORTED + - code: INTERFACE_CONFIG_VLAN_CONFIG_DEFAULT_VLAN_DELETE_UNSUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Element Status Objects for Tenant (v2.2) + summary: Delete Cellular Interface (v4.14) tags: - Device Configuration - /v2.2/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 Cellular Interface + operationId: get-v4.14-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The element ID. + - description: Site Id + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementStatusV2N2' + $ref: '#/components/schemas/InterfaceV4N14' 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) + summary: Get Cellular Interface (v4.14) tags: - Device Configuration - /v2.3/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 + put: + description: Update a Cellular Interface + operationId: put-v4.14-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The client ID. + - description: Site Id in: path - name: client_id + name: site_id required: true schema: - description: Client Id + description: Site Id type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceScreenV4N14' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - type: object - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N14' description: Successful Operation '400': content: @@ -10969,98 +24408,181 @@ paths: example: value: _error: - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: INVALID_ESP_CLIENT + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED + - code: CELLULAR_INTERFACE_TYPE_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_CANNOT_BE_NULL + - code: CELLULAR_INTERFACE_PARENT_MODULE_ID_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_PARENT_SIM_SLOT_NUMBER_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_SITEWAN_NUMBER + - code: CELLULAR_INTERFACE_CONFIG_HARDWARE_RELAY_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_USED_FOR_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_INTERNET + - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_WAN + - code: CELLULAR_INTERFACE_CONFIG_MTU_INVALID + - code: CELLULAR_INTERFACE_CONFIG_DHCP_RELAY_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_LANSTATE_PROPOGATION_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILEID_INVALID_WHEN_AUTOAPN + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_APNPROFILEID_PRESENT + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_NO_USERNAME_BUT_PWD_EXISTS + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_MISSING_WHEN_AUTOAPN_FALSE_APNPROFILEID_NULL + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_INVALID_AUTH + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_MISSING_APN_NAME + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PROFILE_NAME_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILE_ID_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PASSWORD_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_USERNAME_INVALID + - 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 + - code: INTERFACE_CONFIG_VLAN_INVALID_USED_FOR_NOTSUPPORTED + - code: INTERFACE_CONFIG_VLAN_TYPE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_VLAN_INVALID_VLAN_ID + - code: INTERFACE_CONFIG_VLAN_INVALID_DUPLICATE_VLAN_ID + - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_NULL + - code: INTERFACE_CONFIG_SWITCH_PORT_API_UNSUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_NOT_SUPPORTED_ON_ELEMENT + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_USED_FOR_NOTSUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_NETWORK_CONTEXT_NOTSUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_SCOPE_NOTSUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_ACCESS_MISSING_VLANID_ACCESS_OR_VOICE + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_ACCESS_TRUNK_OR_NATIVE_VLANID_NOT_APPLICABLE + - code: INTERFACE_CONFIG_SWITCH_PORT_ACCESS_VLANID_NOT_FOUND + - code: INTERFACE_CONFIG_SWITCH_PORT_VOICE_VLANID_NOT_FOUND + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_MISSING_VLAN_ID_TRUNK_OR_NATIVE + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_ACCESS_OR_VOICE_VLANID_NOT_APPLICABLE + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_NATIVE_VLANID_NOT_FOUND + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_TRUNK_VLANID_NOT_FOUND + - code: INTERFACE_CONFIG_SWITCH_PORT_TRUNK_VLANID_INVALID + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_MAC_AUTH_TYPE + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_MISSING_WHEN_VLANID_PRESENT + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_REAUTH_TIMEOUT + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_STP_PRIORITY + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_STP_COST + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_IPCONFIG_NOTSUPPORTED + - code: SWITCH_PORT_INTERFACE_CONFIG_CANNOT_BE_NULL + - code: SVI_INTERFACE_TYPE_UPDATE_NOT_ALLOWED + - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_UPDATED + - code: INTERFACE_CONFIG_VLAN_INVALID_MSTP_INSTANCE + - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_MAX_LENGTH + - 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 schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Machines of Tenant (v2.3) + summary: Update a Cellular Interface (v4.14) tags: - Device Configuration - /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.3-api-tenants-tenant_id-clients-client_id-machines-query + /v4.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: + get: + description: Get element interfaces + operationId: get-v4.2-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The client ID. + - description: Site Id in: path - name: client_id + name: site_id required: true schema: - description: Client Id + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MachineQuery' responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - type: object + $ref: '#/components/schemas/InterfaceV4N2' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_ESP_CLIENT - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Tenant's Client (v2.3) + summary: Get element interfaces (v4.2) tags: - Device Configuration - /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.3-api-tenants-tenant_id-clients-client_id-machines-machine_id + post: + description: Create an element logical interface + operationId: post-v4.2-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The client ID. + - description: Site Id in: path - name: client_id + name: site_id required: true schema: - description: Client Id + description: Site Id type: string - - description: The device ID. + - description: Element Id in: path - name: machine_id + name: element_id required: true schema: - description: Machine Id + description: Element Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceScreenV4N2' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineV2N3' + $ref: '#/components/schemas/InterfaceV4N2' description: Successful Operation '400': content: @@ -11068,53 +24590,57 @@ paths: example: value: _error: - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: INVALID_ESP_CLIENT - - code: MACHINE_UNKNOWN + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Machine of Tenant (v2.3) + summary: Create an element logical interface (v4.2) tags: - Device Configuration - /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.3-api-tenants-tenant_id-clients-client_id-machines-machine_id-reallocate + /v4.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an element interface + operationId: delete-v4.2-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The client ID. + - description: Site Id in: path - name: client_id + name: site_id required: true schema: - description: Client Id + description: Site Id type: string - - description: The device ID. + - description: Element Id in: path - name: machine_id + name: element_id required: true schema: - description: Machine Id + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MachineInfoV2N3' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineV2N3' + $ref: '#/components/schemas/InterfaceV4N2' description: Successful Operation '400': content: @@ -11122,54 +24648,51 @@ paths: example: value: _error: - - code: INVALID_ESP_CLIENT - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: MACHINE_UNKNOWN - - code: OPERATION_NOT_ALLOWED - - code: INVALID_OPERATION - - code: INVALID_STATE - description: If the machine is not in to_be_returned state or - allocated_to_esp states, use /operations API to move it to to_be_returned - (return operation) or allocated_to_esp (esp_received stock operation) - state, before attempting to reallocate the machine to another - client tenant. - - code: MACHINE_DELETE_DEFAULT_REGION - - code: INVALID_MACHINE_REGION + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Machine (v2.3) + summary: Delete an element interface (v4.2) tags: - Device Configuration - /v2.3/api/tenants/{tenant_id}/elements/status/query: - post: - description: Query and get element the status objects for a tenant. - operationId: post-v2.3-api-tenants-tenant_id-elements-status-query + get: + description: Get element interface details + operationId: get-v4.2-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - in: path + - description: Tenant Id + in: path name: tenant_id required: true schema: description: Tenant Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ElementStatusQuery' + - description: Site Id + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/ElementStatusQuery' - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N2' description: Successful Operation '400': content: @@ -11177,38 +24700,56 @@ paths: example: value: _error: - - code: ELEMENT_STATUS_NOT_FOUND + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Element Status Objects for Tenant (v2.3) + summary: Get element interface details (v4.2) tags: - Device Configuration - /v2.3/api/tenants/{tenant_id}/elements/{element_id}/status: - get: - description: Get a specific element status for a tenant. - operationId: get-v2.3-api-tenants-tenant_id-elements-element_id-status + put: + description: Provision an element interface + operationId: put-v4.2-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The element ID. + - description: Site Id + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceScreenV4N2' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementStatusV2N3' + $ref: '#/components/schemas/InterfaceV4N2' description: Successful Operation '400': content: @@ -11216,83 +24757,100 @@ paths: example: value: _error: - - code: ELEMENT_STATUS_NOT_FOUND + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Element Status for Tenant (v2.3) + summary: Provision an element interface (v4.2) tags: - Device Configuration - /v2.3/api/tenants/{tenant_id}/machines: + /v4.3/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: get: - description: Get all machines of a tenant - operationId: get-v2.3-api-tenants-tenant_id-machines + description: Get element interfaces + operationId: get-v4.3-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - in: path + - description: Tenant Id + 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - $ref: '#/components/schemas/MachineV2N3' + $ref: '#/components/schemas/InterfaceV4N3' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - '404': - description: Machines not found - summary: Get all machines of a tenant (v2.3) + summary: Get element interfaces (v4.3) tags: - Device Configuration - /v2.3/api/tenants/{tenant_id}/machines/query: post: - description: Query the machines of a tenant. - operationId: post-v2.3-api-tenants-tenant_id-machines-query + description: Create an element logical interface + operationId: post-v4.3-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/MachineQuery' + $ref: '#/components/schemas/InterfaceScreenV4N3' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/MachineQueryFilterV2N3' - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N3' description: Successful Operation '400': content: @@ -11300,38 +24858,57 @@ paths: example: value: _error: - - code: BAD_REQUEST + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' - description: Bad request - summary: Query Machine of Tenant (v2.3) + description: Bad Request + summary: Create an element logical interface (v4.3) tags: - Device Configuration - /v2.3/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 + /v4.3/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an element interface + operationId: delete-v4.3-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The machine ID. + - description: Site Id in: path - name: machine_id + name: site_id required: true schema: - description: Machine Id + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineV2N3' + $ref: '#/components/schemas/InterfaceV4N3' description: Successful Operation '400': content: @@ -11339,91 +24916,145 @@ paths: example: value: _error: - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: MACHINE_UNKNOWN + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Tenant Machine (v2.3) + summary: Delete an element interface (v4.3) tags: - Device Configuration - /v2.3/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 + get: + description: Get element interface details + operationId: get-v4.3-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The machine ID. + - description: Site Id in: path - name: machine_id + name: site_id required: true schema: - description: Machine Id + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceV4N3' + description: Successful Operation + summary: Get element interface details (v4.3) + tags: + - Device Configuration + put: + description: Provision an element interface + operationId: put-v4.3-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id + parameters: + - description: Tenant Id + 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/MachineInfoV2N3' + $ref: '#/components/schemas/InterfaceScreenV4N3' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineV2N3' + $ref: '#/components/schemas/InterfaceV4N3' description: Successful Operation '400': content: application/json: - example: - value: - _error: - - code: ESP_OPERATION_NOT_ALLOWED - - code: INVALID_OPERATION - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: SELF_ESP_RECEIVE_STOCK_ERROR - - code: INVALID_ESP_CLIENT - - code: MACHINE_UNKNOWN - - code: INVALID_STATE - - code: LICENSE_NOT_FOUND - - code: MACHINE_INACTIVE - - code: MACHINE_DISCONNECTED - - code: PLEASE_RETRY_LATER - - code: CLAIM_ALREADY_IN_PROGRESS - - code: OPERATION_NOT_ALLOWED - - code: INVALID_ESP_MACHINE_STATE - - code: INVALID_ESP_FOR_MACHINE - - code: OPERATION_NOT_ALLOWED_FOR_VFF + example: + value: + _error: + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Machine (v2.3) + summary: Provision an element interface (v4.3) tags: - Device Configuration - /v2.5/api/tenants/{tenant_id}/clients/{client_id}/machines: + /v4.4/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: get: - description: Get all machines allocated by ESP to a client tenant. - operationId: get-v2.5-api-tenants-tenant_id-clients-client_id-machines + description: Get element interfaces + operationId: get-v4.4-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: Tenant ID of the client tenant of ESP. + - description: Site Id in: path - name: client_id + name: site_id required: true schema: - description: Client Id + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id type: string responses: '200': @@ -11431,65 +25062,53 @@ paths: application/json: schema: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - type: object + $ref: '#/components/schemas/InterfaceV4N4' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: INVALID_ESP_CLIENT - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Machines Allocated by ESP to Client Tenant (v2.5) + summary: Get element interfaces (v4.4) tags: - Device Configuration - /v2.5/api/tenants/{tenant_id}/clients/{client_id}/machines/query: post: - 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 + description: Create an element logical interface + operationId: post-v4.4-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: Tenant ID of the client tenant of ESP. + - description: Site Id in: path - name: client_id + name: site_id required: true schema: - description: Client Id + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/MachineQuery' + $ref: '#/components/schemas/InterfaceScreenV4N4' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - type: object - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N4' description: Successful Operation '400': content: @@ -11497,46 +25116,59 @@ paths: example: value: _error: - - code: INVALID_ESP_CLIENT - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INTERFACE_CONFIG_INTERFACE_TYPE_NOT_SUPPORTED + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Machines Allocated by MSP to Client Tenant (v2.5) + summary: Create an element logical interface (v4.4) tags: - Device Configuration - /v2.5/api/tenants/{tenant_id}/clients/{client_id}/machines/{machine_id}: - get: - 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 + /v4.4/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an element interface + operationId: delete-v4.4-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: Tenant ID of the client tenant of ESP. + - description: Site Id in: path - name: client_id + name: site_id required: true schema: - description: Client Id + description: Site Id type: string - - description: The device ID. + - description: Element Id in: path - name: machine_id + name: element_id required: true schema: - description: Machine Id + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineV2N5' + $ref: '#/components/schemas/InterfaceV4N4' description: Successful Operation '400': content: @@ -11544,53 +25176,98 @@ paths: example: value: _error: - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: INVALID_ESP_CLIENT - - code: MACHINE_UNKNOWN + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Machine allocated by MSP to a Client Tenant (v2.5) + summary: Delete an element interface (v4.4) tags: - Device Configuration - /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.5-api-tenants-tenant_id-clients-client_id-machines-machine_id-reallocate + get: + description: Get element interface details + operationId: get-v4.4-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The client ID. + - description: Site Id in: path - name: client_id + name: site_id required: true schema: - description: Client Id + description: Site Id type: string - - description: The device ID. + - description: Element Id in: path - name: machine_id + name: element_id required: true schema: - description: Machine Id + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceV4N4' + description: Successful Operation + summary: Get element interface details (v4.4) + tags: + - Device Configuration + put: + description: Provision an element interface + operationId: put-v4.4-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id + parameters: + - description: Tenant Id + 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/MachineInfoV2N3' + $ref: '#/components/schemas/InterfaceScreenV4N4' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineV2N5' + $ref: '#/components/schemas/InterfaceV4N4' description: Successful Operation '400': content: @@ -11598,98 +25275,160 @@ paths: example: value: _error: - - code: INVALID_ESP_CLIENT - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: MACHINE_UNKNOWN - - code: OPERATION_NOT_ALLOWED - - code: INVALID_OPERATION - - code: INVALID_STATE - description: If the machine is not in to_be_returned state or - allocated_to_esp states, use /operations API to move it to to_be_returned - (return operation) or allocated_to_esp (esp_received stock operation) - state, before attempting to reallocate the machine to another - client tenant. - - code: MACHINE_DELETE_DEFAULT_REGION - - code: INVALID_MACHINE_REGION + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Machine from Client of same ESP (v2.5) + summary: Provision an element interface (v4.4) tags: - Device Configuration - /v2.5/api/tenants/{tenant_id}/machines: + /v4.5/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: get: - description: Get all the machines of a tenant. - operationId: get-v2.5-api-tenants-tenant_id-machines + description: Get element interfaces + operationId: get-v4.5-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineQuery' allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - $ref: '#/components/schemas/MachineV2N5' + $ref: '#/components/schemas/InterfaceV4N5' type: array type: object description: Successful Operation + summary: Get element interfaces (v4.5) + tags: + - Device Configuration + post: + description: Create an element logical interface + operationId: post-v4.5-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces + parameters: + - description: Tenant Id + 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceScreenV4N5' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceV4N5' + description: Successful Operation '400': content: application/json: example: value: _error: - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: MACHINE_UNKNOWN + - code: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INTERFACE_CONFIG_INTERFACE_TYPE_NOT_SUPPORTED + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - '404': - description: Machines not found - summary: Get Machines of Tenant (v2.5) + summary: Create an element logical interface (v4.5) tags: - Device Configuration - /v2.5/api/tenants/{tenant_id}/machines/query: - post: - description: Query the machines of a tenant. - operationId: post-v2.5-api-tenants-tenant_id-machines-query + /v4.5/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an element interface + operationId: delete-v4.5-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MachineQuery' + - description: Site Id + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/MachineQueryFilterV2N5' - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N5' description: Successful Operation '400': content: @@ -11697,88 +25436,98 @@ paths: example: value: _error: - - code: BAD_REQUEST + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' - description: Bad request - summary: Query Machine of Tenant (v2.5) + description: Bad Request + summary: Delete an element interface (v4.5) tags: - Device Configuration - /v2.5/api/tenants/{tenant_id}/machines/{machine_id}: get: - description: Get a specific machine of a tenant. - operationId: get-v2.5-api-tenants-tenant_id-machines-machine_id + description: Get element interface details + operationId: get-v4.5-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The machine ID. + - description: Site Id in: path - name: machine_id + name: site_id required: true schema: - description: Machine Id + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Machine' + $ref: '#/components/schemas/InterfaceV4N5' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - 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.5) + summary: Get element interface details (v4.5) tags: - Device Configuration - /v2.5/api/tenants/{tenant_id}/machines/{machine_id}/operations: - post: - description: Update a specific machine of a tenant using operations. - operationId: post-v2.5-api-tenants-tenant_id-machines-machine_id-operations + put: + description: Provision an element interface + operationId: put-v4.5-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The machine ID. + - description: Site Id in: path - name: machine_id + name: site_id required: true schema: - description: Machine Id + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/MachineInfoV2N3' + $ref: '#/components/schemas/InterfaceScreenV4N5' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineV2N5' + $ref: '#/components/schemas/InterfaceV4N5' description: Successful Operation '400': content: @@ -11786,88 +25535,100 @@ paths: example: value: _error: - - code: ESP_OPERATION_NOT_ALLOWED - - code: INVALID_OPERATION - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: SELF_ESP_RECEIVE_STOCK_ERROR - - code: INVALID_ESP_CLIENT - - code: MACHINE_UNKNOWN - - code: INVALID_STATE - - code: LICENSE_NOT_FOUND - - code: MACHINE_INACTIVE - - code: MACHINE_DISCONNECTED - - code: PLEASE_RETRY_LATER - - code: CLAIM_ALREADY_IN_PROGRESS - - code: OPERATION_NOT_ALLOWED - - code: INVALID_ESP_MACHINE_STATE - - code: INVALID_ESP_FOR_MACHINE - - code: OPERATION_NOT_ALLOWED_FOR_VFF + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Machine (v2.5) + summary: Provision an element interface (v4.5) tags: - Device Configuration - /v3.0/api/tenants/{tenant_id}/elements: + /v4.6/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: get: - description: Get the element of a tenant. - operationId: get-v3.0-api-tenants-tenant_id-elements + description: Get element interfaces + operationId: get-v4.6-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - $ref: '#/components/schemas/ElementV3' + $ref: '#/components/schemas/InterfaceV4N6' type: array type: object description: Successful Operation - summary: Get Element of Tenant (v3.0) + summary: Get element interfaces (v4.6) tags: - Device Configuration - /v3.0/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 + description: Create an element logical interface + operationId: post-v4.6-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ElementQuery' - description: Queries to the element + $ref: '#/components/schemas/InterfaceScreenV4N6' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/ElementQueryFilterV3' - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N6' description: Successful Operation '400': content: @@ -11875,183 +25636,186 @@ paths: example: value: _error: - - code: BAD_REQUEST + - code: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INTERFACE_CONFIG_INTERFACE_TYPE_NOT_SUPPORTED + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Elements (v3.0) + summary: Create an element logical interface (v4.6) tags: - Device Configuration - /v3.0/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 + /v4.6/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an element interface + operationId: delete-v4.6-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The element ID. + - description: Site Id + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementV3' + $ref: '#/components/schemas/InterfaceV4N6' description: Successful Operation - '404': + '400': content: application/json: + example: + value: + _error: + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' - description: Element not found - summary: Get Element of Tenant (v3.0) + description: Bad Request + summary: Delete an element interface (v4.6) tags: - Device Configuration - put: - description: Update element for associations. - operationId: put-v3.0-api-tenants-tenant_id-elements-element_id + get: + description: Get element interface details + operationId: get-v4.6-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The element ID. + - description: Site Id + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ElementScreenV3' - description: Update to the element + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementScreenV3' + $ref: '#/components/schemas/InterfaceV4N6' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - 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: 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 (v3.0) + summary: Get element interface details (v4.6) tags: - - Device Configuration - /v3.1/api/tenants/{tenant_id}/elements: - get: - description: Get the element of a tenant. - operationId: get-v3.1-api-tenants-tenant_id-elements + - Device Configuration + put: + description: Provision an element interface + operationId: put-v4.6-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceScreenV4N6' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/ElementV3N1' - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N6' description: Successful Operation - summary: Get Element of Tenant (v3.1) + '400': + content: + application/json: + example: + value: + _error: + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Provision an element interface (v4.6) tags: - Device Configuration - /v3.1/api/tenants/{tenant_id}/elements/query: + /v4.7/api/tenants/{tenant_id}/interfaces/query: post: - description: Query the DB for elements that match the query parameters. - operationId: post-v3.1-api-tenants-tenant_id-elements-query + description: Query element interfaces + operationId: post-v4.7-api-tenants-tenant_id-interfaces-query parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true @@ -12062,8 +25826,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementQuery' - description: Queries to the element + $ref: '#/components/schemas/BaseQuery' responses: '200': content: @@ -12074,7 +25837,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/ElementQueryFilterV3N1' + $ref: '#/components/schemas/InterfaceQueryResponseV4N7' type: array type: object description: Successful Operation @@ -12084,26 +25847,37 @@ paths: example: value: _error: - - code: BAD_REQUEST + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Elements (v3.1) + summary: Query element interfaces (v4.7) tags: - Device Configuration - /v3.1/api/tenants/{tenant_id}/elements/{element_id}: + /v4.7/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: get: - description: Get the element of a tenant. - operationId: get-v3.1-api-tenants-tenant_id-elements-element_id + description: Get element interfaces + operationId: get-v4.7-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The element ID. + - description: Site Id + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: Element Id in: path name: element_id required: true @@ -12115,29 +25889,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementV3N1' + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/InterfaceV4N7' + type: array + type: object description: Successful Operation - '404': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Element not found - summary: Get Element of Tenant (v3.1) + summary: Get element interfaces (v4.7) tags: - Device Configuration - put: - description: Update element for associations. - operationId: put-v3.1-api-tenants-tenant_id-elements-element_id + post: + description: Create an element logical interface + operationId: post-v4.7-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The element ID. + - description: Site Id + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: Element Id in: path name: element_id required: true @@ -12148,14 +25930,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementScreenV3N1' - description: Update to the element + $ref: '#/components/schemas/InterfaceScreenV4N7' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementScreenV3N1' + $ref: '#/components/schemas/InterfaceV4N7' description: Successful Operation '400': content: @@ -12163,165 +25944,99 @@ paths: example: value: _error: - - 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: 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: INTERFACE_CONFIG_INTERFACE_TYPE_NOT_SUPPORTED + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Element for Associations (v3.1) + summary: Create an element logical interface (v4.7) tags: - Device Configuration - /v3.1/api/tenants/{tenant_id}/machines/rquery: - post: - description: Query and get all MSP machines across regions. - operationId: post-v3.1-api-tenants-tenant_id-machines-rquery + /v4.7/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an element interface + operationId: delete-v4.7-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MachineQuery' - description: Details of machine query - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/MachineQuery' - type: array - type: object - description: Successful Operation - summary: Query MSP Machines across Regions (v3.1) - tags: - - Device Configuration - /v3.2/api/tenants/{tenant_id}/machines/rquery: - post: - description: Query and get all MSP machines across regions. - operationId: post-v3.2-api-tenants-tenant_id-machines-rquery - parameters: - - description: The tenant ID. + - description: Site Id in: path - name: tenant_id + name: site_id required: true schema: - description: Tenant Id + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MachineQuery' - description: Details of machine query responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/MachineQuery' - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N7' description: Successful Operation - summary: Query MSP Machines across Regions (v3.2) + '400': + content: + application/json: + example: + value: + _error: + - code: SHADIGEST_ELEMENT_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete an element interface (v4.7) tags: - Device Configuration - /v3.5/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 + description: Get element interface details + operationId: get-v4.7-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string - - description: The interface ID. + - description: Interface Id in: path name: interface_id required: true @@ -12333,65 +26048,88 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceStateV3N5' + $ref: '#/components/schemas/InterfaceV4N7' description: Successful Operation - summary: Get Interface Status (v3.5) + summary: Get element interface details (v4.7) tags: - Device Configuration - /v3.6/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: - get: - description: Get interface status. - operationId: get-v3.6-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id-status + put: + description: Provision an element interface + operationId: put-v4.7-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string - - description: The interface ID. + - description: Interface Id in: path name: interface_id required: true schema: description: Interface Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceScreenV4N7' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceStateV3N6' - description: Successful Operation - summary: Get Interface Status (v3.6) + $ref: '#/components/schemas/InterfaceV4N7' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Provision an element interface (v4.7) tags: - Device Configuration - /v4.16/api/tenants/{tenant_id}/interfaces/query: + /v4.8/api/tenants/{tenant_id}/interfaces/query: post: - description: Queries the DB for limit number of interfaces that match query - params. - operationId: post-v4.16-api-tenants-tenant_id-interfaces-query + description: Query element interfaces + operationId: post-v4.8-api-tenants-tenant_id-interfaces-query parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true - schema: null + schema: + description: Tenant Id + type: string requestBody: content: application/json: @@ -12403,37 +26141,51 @@ paths: application/json: schema: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/ListQueryResponse' - properties: items: items: - $ref: '#/components/schemas/BaseQuery' + $ref: '#/components/schemas/InterfaceQueryResponseV4N8' type: array type: object description: Successful Operation - summary: Query all Interfaces (v4.16) + '400': + content: + application/json: + example: + value: + _error: + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query element interfaces (v4.8) tags: - Device Configuration - /v4.16/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: + /v4.8/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: get: - description: Get all interfaces. - operationId: get-v4.16-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces + description: Get element interfaces + operationId: get-v4.8-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true @@ -12446,36 +26198,36 @@ paths: application/json: schema: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - $ref: '#/components/schemas/InterfaceV4N16' + $ref: '#/components/schemas/InterfaceV4N8' type: array type: object description: Successful Operation - summary: Get all Interfaces (v4.16) + summary: Get element interfaces (v4.8) tags: - Device Configuration post: - description: Create an interface. - operationId: post-v4.16-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces + description: Create an element logical interface + operationId: post-v4.8-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true @@ -12486,13 +26238,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceScreenV4N16' + $ref: '#/components/schemas/InterfaceScreenV4N8' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N16' + $ref: '#/components/schemas/InterfaceV4N8' description: Successful Operation '400': content: @@ -12500,87 +26252,47 @@ paths: example: value: _error: - - code: INVALID_JSON_INPUT + - code: ELEMENT_NOT_FOUND - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: NAME_REQD - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE - - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED - - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED - - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED - - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT - - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL - - code: INTERFACE_CONFIG_SERVICE_LINK_TYPE_UPDATE_NOT_ALLOWED - - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST - - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_INTERFACE_TYPE_NOT_SUPPORTED + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET - code: INTERFACE_CONFIG_IP_OVERLAP - - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT - - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE - - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED - - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED - - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED - - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED - - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID - - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID - - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB - - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 - - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED - - code: CELLULAR_INTERFACE_CONFIG_CREATE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_CREATE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_POE_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_VLAN_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_POE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_LLDP_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_API_UNSUPPORTED - - code: INTERFACE_CONFIG_VLAN_INVALID_NOT_SUPPORTED_ON_ELEMENT - - code: INTERFACE_CONFIG_VLAN_INVALID_USED_FOR_NOTSUPPORTED - - code: INTERFACE_CONFIG_VLAN_TYPE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_INVALID_VLAN_ID - - code: INTERFACE_CONFIG_VLAN_INVALID_DUPLICATE_VLAN_ID - - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_NULL - - code: INTERFACE_CONFIG_VLAN_INVALID_MSTP_INSTANCE - - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_MAX_LENGTH - - 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 + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Interface (v4.16) + summary: Create an element logical interface (v4.8) tags: - Device Configuration - /v4.16/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + /v4.8/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: delete: - description: Delete an interface. - operationId: delete-v4.16-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id + description: Delete an element interface + operationId: delete-v4.8-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string - - description: The interface ID. + - description: Interface Id in: path name: interface_id required: true @@ -12592,7 +26304,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N16' + $ref: '#/components/schemas/InterfaceV4N8' description: Successful Operation '400': content: @@ -12600,216 +26312,132 @@ paths: example: value: _error: - - code: CELLULAR_INTERFACE_CONFIG_DELETE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_DELETE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_CONFIG_IN_USE_DELETE_UNSUPPORTED - - code: INTERFACE_CONFIG_VLAN_CONFIG_DEFAULT_VLAN_DELETE_UNSUPPORTED + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Interface (v4.16) + summary: Delete an element interface (v4.8) tags: - Device Configuration get: - 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 - 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/InterfaceV4N16' - description: Successful Operation - summary: Get Interface (v4.16) - tags: - - Device Configuration - put: - description: Update an interface. - operationId: put-v4.16-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id + description: Get element interface details + operationId: get-v4.8-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/InterfaceScreenV4N16' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/InterfaceV4N16' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_INPUT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: NAME_REQD - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE - - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED - - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED - - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT - - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL - - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED - - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST - - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG - - code: INTERFACE_CONFIG_IP_OVERLAP - - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT - - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE - - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED - - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED - - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED - - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED - - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID - - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID - - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB - - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 - - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED - - code: CELLULAR_INTERFACE_TYPE_UPDATE_NOT_ALLOWED - - code: CELLULAR_INTERFACE_CONFIG_CANNOT_BE_NULL - - code: CELLULAR_INTERFACE_PARENT_MODULE_ID_UPDATE_NOT_ALLOWED - - code: CELLULAR_INTERFACE_PARENT_SIM_SLOT_NUMBER_UPDATE_NOT_ALLOWED - - code: CELLULAR_INTERFACE_CONFIG_SITEWAN_NUMBER - - code: CELLULAR_INTERFACE_CONFIG_HARDWARE_RELAY_NOTSUPPORTED - - code: CELLULAR_INTERFACE_CONFIG_USED_FOR_NOTSUPPORTED - - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_INTERNET - - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_WAN - - code: CELLULAR_INTERFACE_CONFIG_MTU_INVALID - - code: CELLULAR_INTERFACE_CONFIG_DHCP_RELAY_NOTSUPPORTED - - code: CELLULAR_INTERFACE_CONFIG_LANSTATE_PROPOGATION_NOTSUPPORTED - - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILEID_INVALID_WHEN_AUTOAPN - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_APNPROFILEID_PRESENT - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_NO_USERNAME_BUT_PWD_EXISTS - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_MISSING_WHEN_AUTOAPN_FALSE_APNPROFILEID_NULL - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_INVALID_AUTH - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_MISSING_APN_NAME - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PROFILE_NAME_INVALID - - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILE_ID_INVALID - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PASSWORD_INVALID - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_USERNAME_INVALID - - code: INTERFACE_CONFIG_POE_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_VLAN_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_POE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_LLDP_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_API_UNSUPPORTED - - code: INTERFACE_CONFIG_VLAN_INVALID_NOT_SUPPORTED_ON_ELEMENT - - code: INTERFACE_CONFIG_VLAN_INVALID_USED_FOR_NOTSUPPORTED - - code: INTERFACE_CONFIG_VLAN_TYPE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_INVALID_VLAN_ID - - code: INTERFACE_CONFIG_VLAN_INVALID_DUPLICATE_VLAN_ID - - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_NULL - - code: INTERFACE_CONFIG_SWITCH_PORT_API_UNSUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_NOT_SUPPORTED_ON_ELEMENT - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_USED_FOR_NOTSUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_NETWORK_CONTEXT_NOTSUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_SCOPE_NOTSUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_ACCESS_MISSING_VLANID_ACCESS_OR_VOICE - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_ACCESS_TRUNK_OR_NATIVE_VLANID_NOT_APPLICABLE - - code: INTERFACE_CONFIG_SWITCH_PORT_ACCESS_VLANID_NOT_FOUND - - code: INTERFACE_CONFIG_SWITCH_PORT_VOICE_VLANID_NOT_FOUND - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_MISSING_VLAN_ID_TRUNK_OR_NATIVE - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_ACCESS_OR_VOICE_VLANID_NOT_APPLICABLE - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_NATIVE_VLANID_NOT_FOUND - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_TRUNK_VLANID_NOT_FOUND - - code: INTERFACE_CONFIG_SWITCH_PORT_TRUNK_VLANID_INVALID - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_MAC_AUTH_TYPE - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_MISSING_WHEN_VLANID_PRESENT - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_REAUTH_TIMEOUT - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_STP_PRIORITY - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_STP_COST - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_IPCONFIG_NOTSUPPORTED - - code: SWITCH_PORT_INTERFACE_CONFIG_CANNOT_BE_NULL - - code: SVI_INTERFACE_TYPE_UPDATE_NOT_ALLOWED - - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_UPDATED - - code: INTERFACE_CONFIG_VLAN_INVALID_MSTP_INSTANCE - - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_MAX_LENGTH - - 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: + description: Site Id + type: string + - description: Element Id + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceV4N8' + description: Successful Operation + summary: Get element interface details (v4.8) + tags: + - Device Configuration + put: + description: Provision an element interface + operationId: put-v4.8-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id + parameters: + - description: Tenant Id + 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Interface Id + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceScreenV4N8' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceV4N8' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Interface (v4.16) + summary: Provision an element interface (v4.8) tags: - Device Configuration - /v4.17/api/tenants/{tenant_id}/interfaces/query: + /v4.9/api/tenants/{tenant_id}/interfaces/query: post: - description: Queries the DB for limit number of interfaces that match query - params. - operationId: post-v4.17-api-tenants-tenant_id-interfaces-query + description: Query element interfaces + operationId: post-v4.9-api-tenants-tenant_id-interfaces-query parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true - schema: null + schema: + description: Tenant Id + type: string requestBody: content: application/json: @@ -12821,37 +26449,49 @@ paths: application/json: schema: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/ListQueryResponse' - properties: items: items: - $ref: '#/components/schemas/BaseQuery' + $ref: '#/components/schemas/InterfaceQueryResponseV4N9' type: array type: object description: Successful Operation - summary: Query all Interfaces (v4.17) + '400': + content: + application/json: + example: + value: + _error: + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query element interfaces (v4.9) tags: - Device Configuration - /v4.17/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: + /v4.9/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces: get: - description: Get all interfaces 4 - operationId: get-v4.17-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces + description: Get element interfaces + operationId: get-v4.9-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true @@ -12864,36 +26504,36 @@ paths: application/json: schema: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - $ref: '#/components/schemas/InterfaceV4N17' + $ref: '#/components/schemas/InterfaceV4N9' type: array type: object description: Successful Operation - summary: Get all Interfaces (v4.17) + summary: Get element interfaces (v4.9) tags: - Device Configuration post: - description: Create an interface. - operationId: post-v4.17-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces + description: Create an element logical interface + operationId: post-v4.9-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true @@ -12904,13 +26544,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceScreenV4N17' + $ref: '#/components/schemas/InterfaceScreenV4N9' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N17' + $ref: '#/components/schemas/InterfaceV4N9' description: Successful Operation '400': content: @@ -12918,89 +26558,47 @@ paths: example: value: _error: - - code: INVALID_JSON_INPUT + - code: ELEMENT_NOT_FOUND - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: NAME_REQD - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE - - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED - - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED - - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED - - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT - - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL - - code: INTERFACE_CONFIG_SERVICE_LINK_TYPE_UPDATE_NOT_ALLOWED - - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST - - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_INTERFACE_TYPE_NOT_SUPPORTED + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET - code: INTERFACE_CONFIG_IP_OVERLAP - - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT - - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE - - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED - - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED - - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED - - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED - - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID - - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID - - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB - - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 - - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED - - code: CELLULAR_INTERFACE_CONFIG_CREATE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_CREATE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_POE_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_VLAN_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_POE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_LLDP_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_API_UNSUPPORTED - - code: INTERFACE_CONFIG_VLAN_INVALID_NOT_SUPPORTED_ON_ELEMENT - - code: INTERFACE_CONFIG_VLAN_INVALID_USED_FOR_NOTSUPPORTED - - code: INTERFACE_CONFIG_VLAN_TYPE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_INVALID_VLAN_ID - - code: INTERFACE_CONFIG_VLAN_INVALID_DUPLICATE_VLAN_ID - - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_NULL - - code: INTERFACE_CONFIG_VLAN_INVALID_MSTP_INSTANCE - - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_MAX_LENGTH - - 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 - - code: INTERFACE_CONFIG_CONTROLLER_INTF_ALREADY_EXISTS - - code: INTERFACE_CONFIG_USED_FOR_CONTROLLER_NOT_SUPPORTED + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Interface (v4.17) + summary: Create an element logical interface (v4.9) tags: - Device Configuration - /v4.17/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + /v4.9/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: delete: - description: Delete an interface. - operationId: delete-v4.17-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id + description: Delete an element interface + operationId: delete-v4.9-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string - - description: The interface ID. + - description: Interface Id in: path name: interface_id required: true @@ -13012,7 +26610,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N17' + $ref: '#/components/schemas/InterfaceV4N9' description: Successful Operation '400': content: @@ -13020,42 +26618,39 @@ paths: example: value: _error: - - code: CELLULAR_INTERFACE_CONFIG_DELETE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_DELETE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_CONFIG_IN_USE_DELETE_UNSUPPORTED - - code: INTERFACE_CONFIG_VLAN_CONFIG_DEFAULT_VLAN_DELETE_UNSUPPORTED + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Interface (v4.17) + summary: Delete an element interface (v4.9) tags: - Device Configuration get: - description: Get an interface. - operationId: get-v4.17-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id + description: Get element interface details + operationId: get-v4.9-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string - - description: The interface ID. + - description: Interface Id in: path name: interface_id required: true @@ -13067,37 +26662,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N17' + $ref: '#/components/schemas/InterfaceV4N9' description: Successful Operation - summary: Get Interface (v4.17) + summary: Get element interface details (v4.9) tags: - Device Configuration put: - description: Update an interface. - operationId: put-v4.17-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id + description: Provision an element interface + operationId: put-v4.9-api-tenants-tenant_id-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The site ID. + - description: Site Id in: path name: site_id required: true schema: description: Site Id type: string - - description: The element ID. + - description: Element Id in: path name: element_id required: true schema: description: Element Id type: string - - description: The interface ID. + - description: Interface Id in: path name: interface_id required: true @@ -13108,13 +26703,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceScreenV4N17' + $ref: '#/components/schemas/InterfaceScreenV4N9' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N17' + $ref: '#/components/schemas/InterfaceV4N9' description: Successful Operation '400': content: @@ -13122,103 +26717,19 @@ paths: example: value: _error: - - code: INVALID_JSON_INPUT + - code: INTERFACE_NOT_FOUND - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: NAME_REQD - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE - - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED - - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED - - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT - - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL - - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED - - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST - - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET - code: INTERFACE_CONFIG_IP_OVERLAP - - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT - - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE - - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED - - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED - - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED - - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED - - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID - - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID - - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB - - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 - - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED - - code: CELLULAR_INTERFACE_TYPE_UPDATE_NOT_ALLOWED - - code: CELLULAR_INTERFACE_CONFIG_CANNOT_BE_NULL - - code: CELLULAR_INTERFACE_PARENT_MODULE_ID_UPDATE_NOT_ALLOWED - - code: CELLULAR_INTERFACE_PARENT_SIM_SLOT_NUMBER_UPDATE_NOT_ALLOWED - - code: CELLULAR_INTERFACE_CONFIG_SITEWAN_NUMBER - - code: CELLULAR_INTERFACE_CONFIG_HARDWARE_RELAY_NOTSUPPORTED - - code: CELLULAR_INTERFACE_CONFIG_USED_FOR_NOTSUPPORTED - - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_INTERNET - - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_WAN - - code: CELLULAR_INTERFACE_CONFIG_MTU_INVALID - - code: CELLULAR_INTERFACE_CONFIG_DHCP_RELAY_NOTSUPPORTED - - code: CELLULAR_INTERFACE_CONFIG_LANSTATE_PROPOGATION_NOTSUPPORTED - - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILEID_INVALID_WHEN_AUTOAPN - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_APNPROFILEID_PRESENT - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_NO_USERNAME_BUT_PWD_EXISTS - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_MISSING_WHEN_AUTOAPN_FALSE_APNPROFILEID_NULL - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_INVALID_AUTH - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_MISSING_APN_NAME - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PROFILE_NAME_INVALID - - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILE_ID_INVALID - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PASSWORD_INVALID - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_USERNAME_INVALID - - code: INTERFACE_CONFIG_POE_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_VLAN_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_POE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_LLDP_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_API_UNSUPPORTED - - code: INTERFACE_CONFIG_VLAN_INVALID_NOT_SUPPORTED_ON_ELEMENT - - code: INTERFACE_CONFIG_VLAN_INVALID_USED_FOR_NOTSUPPORTED - - code: INTERFACE_CONFIG_VLAN_TYPE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_INVALID_VLAN_ID - - code: INTERFACE_CONFIG_VLAN_INVALID_DUPLICATE_VLAN_ID - - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_NULL - - code: INTERFACE_CONFIG_SWITCH_PORT_API_UNSUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_NOT_SUPPORTED_ON_ELEMENT - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_USED_FOR_NOTSUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_NETWORK_CONTEXT_NOTSUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_SCOPE_NOTSUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_ACCESS_MISSING_VLANID_ACCESS_OR_VOICE - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_ACCESS_TRUNK_OR_NATIVE_VLANID_NOT_APPLICABLE - - code: INTERFACE_CONFIG_SWITCH_PORT_ACCESS_VLANID_NOT_FOUND - - code: INTERFACE_CONFIG_SWITCH_PORT_VOICE_VLANID_NOT_FOUND - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_MISSING_VLAN_ID_TRUNK_OR_NATIVE - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_ACCESS_OR_VOICE_VLANID_NOT_APPLICABLE - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_NATIVE_VLANID_NOT_FOUND - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_TRUNK_VLANID_NOT_FOUND - - code: INTERFACE_CONFIG_SWITCH_PORT_TRUNK_VLANID_INVALID - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_MAC_AUTH_TYPE - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_MISSING_WHEN_VLANID_PRESENT - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_REAUTH_TIMEOUT - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_STP_PRIORITY - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_STP_COST - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_IPCONFIG_NOTSUPPORTED - - code: SWITCH_PORT_INTERFACE_CONFIG_CANNOT_BE_NULL - - code: SVI_INTERFACE_TYPE_UPDATE_NOT_ALLOWED - - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_UPDATED - - code: INTERFACE_CONFIG_VLAN_INVALID_MSTP_INSTANCE - - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_MAX_LENGTH - - 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 - - code: INTERFACE_CONFIG_CONTROLLER_INTF_ALREADY_EXISTS - - code: INTERFACE_CONFIG_USED_FOR_CONTROLLER_NOT_SUPPORTED + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Interface (v4.17) + summary: Provision an element interface (v4.9) tags: - Device Configuration servers: diff --git a/openapi-specs/sdwan/legacy/DeviceSwitchConfiguration.yaml b/openapi-specs/sdwan/legacy/DeviceSwitchConfiguration.yaml index e995a8ae0..7dd3d74fd 100644 --- a/openapi-specs/sdwan/legacy/DeviceSwitchConfiguration.yaml +++ b/openapi-specs/sdwan/legacy/DeviceSwitchConfiguration.yaml @@ -2,21 +2,9 @@ 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: @@ -26,28 +14,6 @@ components: - 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 ClientDetails: properties: aging_timeout: @@ -108,6 +74,15 @@ components: ' type: integer + required: + - stats_start_time_ms + - uptime + - reauth_timeout + - vlan_id + - username + - mac_address + - interface_id + - element_id ElementRadius: properties: description: diff --git a/openapi-specs/sdwan/legacy/EventPolicy.yaml b/openapi-specs/sdwan/legacy/EventPolicy.yaml index f347ebfb0..c3b7665ff 100644 --- a/openapi-specs/sdwan/legacy/EventPolicy.yaml +++ b/openapi-specs/sdwan/legacy/EventPolicy.yaml @@ -2,21 +2,9 @@ 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: @@ -26,28 +14,6 @@ components: - 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 Error: properties: _error: @@ -156,7 +122,6 @@ 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 @@ -165,7 +130,6 @@ 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 @@ -221,20 +185,6 @@ components: - 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: @@ -277,7 +227,6 @@ components: - bgppeer - interface - waninterface - - wannetwork - networkpolicyset - prioritypolicyset - natpolicyset @@ -285,7 +234,6 @@ components: - appdef - serviceendpoint - cellular_module - - user_id type: string start_time: description: 'The start date in MM/DD/YYYY HH: mm format of the event policy @@ -472,7 +420,6 @@ 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 @@ -481,7 +428,6 @@ 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 @@ -537,20 +483,6 @@ components: - 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: @@ -598,7 +530,6 @@ components: - bgppeer - interface - waninterface - - wannetwork - networkpolicyset - prioritypolicyset - natpolicyset @@ -606,7 +537,6 @@ components: - appdef - serviceendpoint - cellular_module - - user_id type: string start_time: description: 'The start date in MM/DD/YYYY HH: mm format of the event policy @@ -649,849 +579,8 @@ components: - priority - suppress - name - EventCorrelationPolicyRuleQueryFilterV2N1: + EventCorrelationPolicyRuleScreen: properties: - dampening_duration: - description: 'Dampening duration cannot be less than 5 minutes. Dampening - for duration cannot be more than 10080 minutes(a week). - - ' - type: integer - description: - description: 'Description of the event correlation policy rules. - - ' - enabled: - description: 'The enabled event correlation policy rules. - - ' - 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 - 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: 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: 'ID of the event policy set. - - ' - type: string - 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: - description: 'Priority level set for the event policy rule. - - ' - enum: - - p1 - - p2 - - p3 - - p4 - - p5 - - none - type: string - 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: - - site - - element - - anynetlink - - bgppeer - - interface - - waninterface - - wannetwork - - networkpolicyset - - prioritypolicyset - - natpolicyset - - securitypolicyset - - appdef - - serviceendpoint - - cellular_module - - user_id - type: string - start_time: - description: 'The start date in MM/DD/YYYY HH: mm format of the event policy - rule applied. - - ' - 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 - 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 - required: - - 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: - description: 'Description of the event correlation policy rules. - - ' - enabled: - description: 'The enabled event correlation policy rules. - - ' - 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 - 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: 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: 'ID of the event policy set. - - ' - type: string - name: - description: 'Name of the event policy set. Max 25 characters. - - ' - type: string - priority: - description: 'Priority level set for the event policy rule. - - ' - enum: - - p1 - - p2 - - p3 - - p4 - - p5 - - none - type: string - 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: - - site - - element - - anynetlink - - bgppeer - - interface - - waninterface - - wannetwork - - networkpolicyset - - prioritypolicyset - - natpolicyset - - securitypolicyset - - appdef - - serviceendpoint - - cellular_module - - user_id - type: string - start_time: - description: 'The start date in MM/DD/YYYY HH: mm format of the event policy - rule applied. - - ' - 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 - 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. \n" - items: - description: Tags - type: string - type: array - required: - - priority - - suppress - - name - EventCorrelationPolicyRuleScreenV2N1: - properties: - dampening_duration: - description: 'Dampening duration cannot be less than 5 minutes. Dampening - for duration cannot be more than 10080 minutes(a week). - - ' - type: integer - description: - description: 'Description of the event correlation policy rules. - - ' - enabled: - description: 'The enabled event correlation policy rules. - - ' - 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 - 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: 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: 'ID of the event policy set. - - ' - type: string - name: - description: 'Name of the event policy set. Max 25 characters. - - ' - type: string - priority: - description: 'Priority level set for the event policy rule. - - ' - enum: - - p1 - - p2 - - p3 - - p4 - - p5 - - none - type: string - 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: - - site - - element - - anynetlink - - bgppeer - - interface - - waninterface - - wannetwork - - networkpolicyset - - prioritypolicyset - - natpolicyset - - securitypolicyset - - appdef - - serviceendpoint - - cellular_module - - user_id - type: string - start_time: - description: 'The start date in MM/DD/YYYY HH: mm format of the event policy - rule applied. - - ' - 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 - 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 - 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: integer description: description: 'Description of the event correlation policy rules. @@ -1567,7 +656,6 @@ 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 @@ -1576,7 +664,6 @@ 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 @@ -1632,20 +719,6 @@ components: - 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: @@ -1688,7 +761,6 @@ components: - bgppeer - interface - waninterface - - wannetwork - networkpolicyset - prioritypolicyset - natpolicyset @@ -1696,7 +768,6 @@ components: - appdef - serviceendpoint - cellular_module - - user_id type: string start_time: description: 'The start date in MM/DD/YYYY HH: mm format of the event policy @@ -1728,11 +799,9 @@ 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. - - ' + 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 @@ -2595,281 +1664,6 @@ paths: summary: Update Event Correlation Policy Rule Configuration (v2.0) tags: - Event Policy - /v2.1/api/tenants/{tenant_id}/eventcorrelationpolicyrules/query: - post: - 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: 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/EventCorrelationPolicyRuleQueryV2N1' - description: Details for Event Correlation Policy Rule - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/EventCorrelationPolicyRuleQueryFilterV2N1' - 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: Queries DB for Number of Event Correlation Policy Rules (v2.1) - tags: - - Event Policy - /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: ID of the tenant. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - 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/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' - type: array - type: object - description: Successful Operation - summary: Get Event Correlation Policy Rules (v2.1) - tags: - - Event Policy - post: - description: Create the event correlation policy rule configuration. - operationId: post-v2.1-api-tenants-tenant_id-eventcorrelationpolicysets-policy_set_id-eventcorrelationpolicyrules - parameters: - - description: ID of the tenant. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: ID of the event policy set. - in: path - name: policy_set_id - required: true - schema: - 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/EventCorrelationPolicyRuleV2N1' - description: Successful Operation - '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.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: ID of the tenant. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: ID of the event policy set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: ID of the event policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' - description: Successful Operation - '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 - get: - 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: ID of the tenant. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: ID of the event policy set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: ID of the event policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' - description: Successful Operation - summary: Get Event Correlation Policy Rule (v2.1) - tags: - - Event Policy - 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: ID of the tenant. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: ID of the event policy set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: ID of the event policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/EventCorrelationPolicyRuleScreenV2N1' - description: Details of the event correlation policyrule to be updated - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' - description: Successful Operation - '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: Update Event Correlation Policy Rule Configuration (v2.1) - tags: - - Event Policy servers: - url: https://api.us.cloudgenix.com tags: diff --git a/openapi-specs/sdwan/legacy/Events.yaml b/openapi-specs/sdwan/legacy/Events.yaml index de0f6a50f..6115f4c3d 100644 --- a/openapi-specs/sdwan/legacy/Events.yaml +++ b/openapi-specs/sdwan/legacy/Events.yaml @@ -34,21 +34,9 @@ components: 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: @@ -58,28 +46,6 @@ components: - 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: diff --git a/openapi-specs/sdwan/legacy/IPFIX.yaml b/openapi-specs/sdwan/legacy/IPFIX.yaml index ec78f5aaa..817f645cb 100644 --- a/openapi-specs/sdwan/legacy/IPFIX.yaml +++ b/openapi-specs/sdwan/legacy/IPFIX.yaml @@ -2,21 +2,9 @@ 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: @@ -26,28 +14,6 @@ components: - 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 BulkResponse: properties: count: diff --git a/openapi-specs/sdwan/legacy/Metrics.yaml b/openapi-specs/sdwan/legacy/Metrics.yaml index 151ad64ad..52ab146dc 100644 --- a/openapi-specs/sdwan/legacy/Metrics.yaml +++ b/openapi-specs/sdwan/legacy/Metrics.yaml @@ -1,74 +1,5 @@ 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 - AggregateMetric: - properties: - name: - description: 'The name of the aggregate metric. - - ' - type: string - statistic: - description: 'QoS application aggregate statistics. - - ' - type: string - unit: - description: 'The unit. - - ' - type: string - required: - - statistic - - unit - - name AggregateStatsFilter: properties: app: @@ -96,8 +27,7 @@ components: type: string type: array required: - - site - - app + - path AggregateStatsQuery: properties: aggregates: @@ -130,6 +60,9 @@ components: required: - filter - aggregates + - start_time + - name + - end_time AggregateStatsResponse: properties: aggregates: @@ -152,15 +85,10 @@ components: ' format: date type: string - AggregatesQueryResponse: - properties: - aggregates: - description: 'The application QoS aggregates. - - ' - items: - $ref: '#/components/schemas/Aggregate' - type: array + required: + - aggregates + - end_time + - start_time AppObjectStatsResponse: properties: data: @@ -181,7 +109,6 @@ components: - IntfStatistics - CellularModuleStatistics - CellularAPNStatistics - - CellularAPNV6Statistics - MulticastStatistics - SecurityPolicyRule - IntfPoEStatistics @@ -195,6 +122,12 @@ components: start_time: format: date type: string + required: + - filter + - data + - object_type + - end_time + - start_time AppStatsAggregate: properties: name: @@ -212,6 +145,7 @@ components: description: Unit type: string required: + - unit - name AppStatsAggregateData: properties: @@ -242,6 +176,12 @@ components: unit: description: Unit type: string + required: + - unit + - name + - start_time + - end_time + - data AppStatsAggregateFilter: properties: app: @@ -303,6 +243,10 @@ components: start_time: description: "The start time to get the app statistics. \n" type: string + required: + - end_time + - start_time + - aggregates AppStatsAggregatesQuery: properties: aggregates: @@ -334,12 +278,18 @@ components: format: date type: string required: + - filter - aggregates + - start_time + - name + - end_time AppStatsFilter: properties: health_score: description: Health Score type: map[appstatsoperatortype,string] + required: + - health_score AppStatsSupportedAggregate: properties: description: @@ -359,6 +309,10 @@ components: description: Units type: string type: array + required: + - units + - name + - description AppStatsSupportedAggregatesResponse: properties: aggregates: @@ -366,6 +320,8 @@ components: items: $ref: '#/components/schemas/AppStatsSupportedAggregate' type: array + required: + - aggregates AppStatsTopNFilter: properties: app: @@ -472,8 +428,12 @@ components: - egress_audio_mos type: string required: + - filter - topn_basis - top_n + - start_time + - name + - end_time AppStatsTopNResponse: properties: top_n: @@ -481,6 +441,8 @@ components: description: 'The details of the Top N reports. ' + required: + - top_n AppStatsTopNResponseData: properties: end_time: @@ -537,6 +499,13 @@ components: - app - site type: string + required: + - topn_basis + - type + - items + - start_time + - limit + - end_time AppStatsTopNView: properties: limit: @@ -552,197 +521,7 @@ components: type: string required: - type - ApplicationQosAggregatesQuery: - properties: - aggregates: - description: 'The aggregate number of supported app stats. Max number = - 10. - - ' - items: - $ref: '#/components/schemas/AggregateMetric' - type: array - end_time: - description: 'The end time to get the app stats. - - ' - format: date - type: string - filter: - $ref: '#/components/schemas/ApplicationQosMetricsFilter' - 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. - - ' - format: date - type: string - view: - $ref: '#/components/schemas/View' - description: "View the QoS metric details. \n" - required: - - filter - - aggregates - ApplicationQosMetricsFilter: - properties: - application_name: - description: 'Filter by the name of the application. - - ' - type: string - direction: - description: 'Filter by the traffic direction. - - ' - enum: - - Ingress - - Egress - type: string - email: - description: 'Filter by the email address. - - ' - items: - description: Email - type: string - type: array - site: - description: 'Filter by the site. - - ' - items: - description: Site - type: string - type: array - user: - description: "Filter by user. \n" - items: - description: User - type: string - type: array - required: - - application_name - ApplicationQosMetricsQuery: - properties: - end_time: - description: 'The end time to get the application QoS metrics. - - ' - format: date - type: string - filter: - $ref: '#/components/schemas/ApplicationQosMetricsFilter' - description: 'Filters according to the specifications. - - ' - interval: - description: 'The interval time of the application QoS metrics. - - ' - enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day - type: string - max_datapoints: - description: 'The max datapoints of the application QoS metrics. - - ' - format: int32 - type: integer - metrics: - description: 'Details of the application QoS metrics. - - ' - items: - $ref: '#/components/schemas/Metrics' - type: array - name: - description: 'The name of the Application QoS metric. - - ' - type: string - start_time: - description: "The start time to get the application QoS metrics. \ - \ \n" - format: date - type: string - view: - $ref: '#/components/schemas/View' - description: View - required: - - filter - - interval - - metrics - ApplicationQosMetricsResponse: - properties: - metrics: - description: 'Details of the application metrics. - - ' - items: - $ref: '#/components/schemas/Metrics' - type: array - ApplicationUserData: - properties: - client_ip: - description: 'The client IP address. - - ' - type: string - email: - description: 'The email ID of the application user. - - ' - type: string - site: - description: 'The site. - - ' - type: string - user_name: - description: "The user name of the application user. \n" - type: string - ApplicationUsersQuery: - properties: - application_name: - description: 'Filter by application name. - - ' - type: string - end_time: - description: 'Filter by end time. - - ' - format: date - type: string - name: - description: 'Filter by app name. - - ' - type: string - start_time: - description: 'Filter by end time. - - ' - format: date - type: string - required: - - application_name - ApplicationUsersResponse: - properties: - data: - description: Data - items: - $ref: '#/components/schemas/ApplicationUserData' - type: array + - limit BaseTopNQuery: properties: end_time: @@ -780,8 +559,12 @@ components: ' type: string required: + - filter - topn_basis - top_n + - start_time + - name + - end_time BaseTopNResponse: properties: top_n: @@ -789,6 +572,8 @@ components: description: 'The details of the Top N reports. ' + required: + - top_n BaseTopNResponseData: properties: end_time: @@ -826,6 +611,13 @@ components: ' type: string + required: + - topn_basis + - type + - items + - start_time + - limit + - end_time BaseTopNView: properties: limit: @@ -841,6 +633,7 @@ components: type: string required: - type + - limit CapacityPredictionFilter: properties: direction: @@ -867,14 +660,12 @@ 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. @@ -905,8 +696,6 @@ components: - CAPACITY_EXCEED_THRESHOLD - ANOMALY - CIRCUIT_CAPACITY_FORECAST - - CIRCUIT_UTILIZATION - - ANOMALY_SITE_CIRCUIT_DETAILS type: string type: array forecast_date: @@ -936,17 +725,17 @@ 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: "The details of the forecast. \n" type: object @@ -954,13 +743,9 @@ components: 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: @@ -1012,6 +797,13 @@ components: description: Site type: string type: array + required: + - carrier + - apn + - cellular_module + - direction + - site + - element CellularmetricsQuery: properties: end_time: @@ -1031,11 +823,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string max_datapoints: description: 'The max data points. @@ -1071,8 +863,14 @@ components: ' required: + - filter + - view + - max_datapoints - interval - metrics + - start_time + - name + - end_time CellularmetricsResponse: properties: metrics: @@ -1080,6 +878,8 @@ components: items: $ref: '#/components/schemas/Metrics' type: array + required: + - metrics CellularmetricsSchemaResponse: properties: metrics: @@ -1089,6 +889,8 @@ components: items: $ref: '#/components/schemas/MetricSchema' type: array + required: + - metrics ClientDetails: properties: aging_timeout: @@ -1149,6 +951,15 @@ components: ' type: integer + required: + - stats_start_time_ms + - uptime + - reauth_timeout + - vlan_id + - username + - mac_address + - interface_id + - element_id Data: properties: datapoints: @@ -1159,6 +970,9 @@ components: statistics: description: Statistics type: object + required: + - datapoints + - statistics Datapoints: properties: duration: @@ -1178,9 +992,6 @@ components: description: Links type: string type: array - ninetieth_percentile: - description: Ninetieth Percentile - type: number sites: description: 'The sites. @@ -1194,6 +1005,12 @@ components: ' type: number + required: + - filter_property_id + - sites + - links + - value + - duration Error: properties: _error: @@ -1240,11 +1057,143 @@ components: ' type: string - FlowSummary: + 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: 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 @@ -1253,18 +1202,56 @@ 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 @@ -1273,21 +1260,173 @@ 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_v6: - description: Is V6 + is_sec_policy_present: + description: Is Sec Policy Present 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 @@ -1305,39 +1444,257 @@ 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 - sec_policy_actions: - description: Sec Policy Actions + 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 items: - description: Sec Policy Actions + description: Sec Fc App Id 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 + description: 'Service Endpoint Id: JsonInclude(content = ALWAYS, contentFilter + = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' 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 - user_name: - description: User Name + unknown_reason: + description: Unknown Reason + 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]) ' type: string - vrf_id: - description: Vrf Id + 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: + - 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: @@ -1367,6 +1724,12 @@ components: description: Source Port type: integer type: array + required: + - source_port + - source_ip + - protocol + - destination_port + - destination_ip Flows: properties: debug_level: @@ -1378,13 +1741,18 @@ components: items: description: "The flow summary information. \n" items: - $ref: '#/components/schemas/FlowSummary' + $ref: '#/components/schemas/FlowDetails' type: array start_time: description: 'The start time to get the flow information. ' type: string + required: + - start_time + - items + - end_time + - debug_level FlowsFilter: properties: app: @@ -1487,6 +1855,19 @@ components: 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: @@ -1520,11 +1901,20 @@ 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: @@ -1533,12 +1923,6 @@ 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. @@ -1559,8 +1943,6 @@ components: - CAPACITY_EXCEED_THRESHOLD - ANOMALY - CIRCUIT_CAPACITY_FORECAST - - CIRCUIT_UTILIZATION - - ANOMALY_SITE_CIRCUIT_DETAILS type: string type: description: 'The type of forecast. @@ -1569,8 +1951,13 @@ 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: @@ -1588,6 +1975,10 @@ components: ' type: string + required: + - direction + - wn_path + - site HealthData: properties: fair: @@ -1608,6 +1999,13 @@ components: type: description: Type type: string + required: + - others + - good + - fair + - poor + - total + - type HealthFilter: properties: application_health: @@ -1646,6 +2044,10 @@ components: - ALL type: string type: array + required: + - application_health + - link_health + - site_health HealthScoreQuery: properties: end_time: @@ -1664,11 +2066,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string name: description: 'The name of the healthscore filter. @@ -1689,6 +2091,13 @@ components: - SUMMARY - TIMESERIES type: string + required: + - view + - filter + - interval + - start_time + - name + - end_time HealthScoreResponse: properties: data: @@ -1707,11 +2116,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string start_time: description: 'The start time to get the health data. @@ -1724,6 +2133,12 @@ components: ' type: object + required: + - view + - data + - end_time + - start_time + - interval LqmStatsAggregateHealthScoreRequest: properties: aggregation: @@ -1761,6 +2176,9 @@ components: required: - healthscore_type - aggregation + - start_time + - name + - end_time LqmStatsAggregateHealthScoreResponse: properties: aggregation: @@ -1794,34 +2212,57 @@ 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: tenant_id: - description: Tenant Id + description: 'The tenant ID. + + ' type: string value: - description: Value + description: 'The LQM stats health score. + + ' format: int32 type: integer + required: + - value + - tenant_id LqmStatsHealthScoreAggregateData: properties: count: - description: Count + description: 'The number of LQM Health Scores. + + ' format: int32 type: integer data: - description: Data + description: 'The tenant''s LQM health score. + + ' items: $ref: '#/components/schemas/LqmStatsClientHealthScoreAggregateData' type: array health: - description: Health + description: 'The health values. + + ' enum: - others - poor - fair - good type: string + required: + - count + - data + - health MetricSchema: properties: description: @@ -1849,6 +2290,11 @@ components: description: Units type: string type: array + required: + - description + - statistics + - units + - name MetricSchemaResponse: properties: metrics: @@ -1858,6 +2304,8 @@ components: items: $ref: '#/components/schemas/MetricSchema' type: array + required: + - metrics Metrics: properties: series: @@ -1867,6 +2315,8 @@ components: items: $ref: '#/components/schemas/Series' type: array + required: + - series MonitorMetricsFilter: properties: anynet_link: @@ -1943,6 +2393,17 @@ 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: @@ -1961,11 +2422,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string max_datapoints: description: 'The max data points. @@ -1995,8 +2456,14 @@ components: ' required: + - filter + - view + - max_datapoints - interval - metrics + - start_time + - name + - end_time MonitorMetricsResponse: properties: metrics: @@ -2006,6 +2473,8 @@ components: items: $ref: '#/components/schemas/Metrics' type: array + required: + - metrics MulticastRouteIncomingInterface: properties: iif: @@ -2023,6 +2492,10 @@ components: ' type: string + required: + - is_site_interface + - wanpath + - iif MulticastRouteOutgoingInterface: properties: is_site_interface: @@ -2041,6 +2514,10 @@ components: description: Wanpaths type: string type: array + required: + - is_site_interface + - wanpaths + - oif MulticastRouteOutgoingInterfaceStatsData: properties: is_site_interface: @@ -2054,6 +2531,10 @@ components: items: $ref: '#/components/schemas/MulticastRouteWanpathStatsData' type: array + required: + - is_site_interface + - wanpaths + - oif MulticastRouteOutgoingInterfaceStatsResponse: properties: end_time: @@ -2067,6 +2548,10 @@ components: start_time: description: Start Time type: string + required: + - start_time + - end_time + - oif_list MulticastRouteSourceGroupStatsData: properties: flags: @@ -2110,6 +2595,14 @@ components: ' type: string + required: + - rx_packets + - rx_bytes + - flags + - outgoing_interfaces + - incoming_interface + - group + - source MulticastRouteSourceGroupStatsResponse: properties: end_time: @@ -2129,6 +2622,10 @@ components: ' type: string + required: + - source_group_list + - start_time + - end_time MulticastRouteStatsFilter: properties: element: @@ -2164,6 +2661,7 @@ components: type: string type: array required: + - group - source - site - element @@ -2208,6 +2706,9 @@ components: - is_active - type - filter + - start_time + - name + - end_time MulticastRouteWanpathStatsData: properties: last_active: @@ -2224,6 +2725,11 @@ components: wanpath: description: Wanpath type: string + required: + - last_active + - tx_packets + - tx_bytes + - wanpath MulticastWANNeighborStatsFilter: properties: element: @@ -2290,6 +2796,9 @@ components: required: - filter - object_type + - start_time + - name + - end_time MulticastWANPIMStatsData: properties: end_time: @@ -2377,6 +2886,22 @@ 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: @@ -2384,6 +2909,8 @@ components: description: 'The multicast WAN PIM statistics. ' + required: + - data MulticastWANPathStats: properties: rx_bytes: @@ -2419,6 +2946,12 @@ components: ' type: string + required: + - rx_bytes + - tx_bytes + - tx_packets + - rx_packets + - wanpath MulticastWANPathStatsData: properties: end_time: @@ -2441,6 +2974,11 @@ components: items: $ref: '#/components/schemas/MulticastWANPathStats' type: array + required: + - wanpath_list + - remote_site_id + - start_time + - end_time MulticastWANPathStatsResponse: properties: data: @@ -2448,6 +2986,8 @@ components: description: 'The multicast WAN path statistics. ' + required: + - data MulticastWANTrafficStatsData: properties: end_time: @@ -2489,6 +3029,14 @@ components: ' format: int64 type: integer + required: + - rx_bytes + - tx_bytes + - tx_packets + - rx_packets + - remote_site_id + - start_time + - end_time MulticastWANTrafficStatsResponse: properties: data: @@ -2496,6 +3044,8 @@ components: description: 'The multicast WAN traffic statistics. ' + required: + - data NetworkPointMetrics: properties: name: @@ -2513,6 +3063,10 @@ components: unit: description: Unit type: string + required: + - sites + - unit + - name NetworkPointMetricsFilter: properties: direction: @@ -2560,6 +3114,13 @@ components: description: Waninterface type: string type: array + required: + - direction + - waninterface + - interface + - site + - sites + - element NetworkPointMetricsQuery: properties: end_time: @@ -2579,11 +3140,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string metrics: description: 'The details of the network point metric. Metrics need to specified @@ -2610,6 +3171,9 @@ components: - filter - metrics - interval + - start_time + - name + - end_time NetworkPointMetricsResponse: properties: interval: @@ -2617,11 +3181,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string metrics: description: 'The details of the network point metric. Metrics need to specified @@ -2644,6 +3208,11 @@ components: description: 'The individual and summary views. ' + required: + - view + - interval + - start_time + - metrics ObjectStatsFilter: properties: element: @@ -2660,8 +3229,6 @@ components: description: Site type: string type: array - required: - - site ObjectStatsQuery: properties: end_time: @@ -2692,7 +3259,6 @@ components: - IntfStatistics - CellularModuleStatistics - CellularAPNStatistics - - CellularAPNV6Statistics - MulticastStatistics - SecurityPolicyRule - IntfPoEStatistics @@ -2713,10 +3279,15 @@ components: - filter - object_id - object_type + - start_time + - name + - end_time ObjectStatsResponse: properties: data: type: object + required: + - data ObjectStatsType: properties: description: @@ -2728,6 +3299,9 @@ components: ' type: string + required: + - description + - name ObjectStatsTypeResponse: properties: object_statistics: @@ -2737,6 +3311,8 @@ components: items: $ref: '#/components/schemas/ObjectStatsType' type: array + required: + - object_statistics PointData: properties: avail_disk: @@ -2856,6 +3432,33 @@ 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: @@ -2868,6 +3471,9 @@ components: description: 'The data of the point metric Anynet. ' + required: + - data + - anynet_link_id PointMetricsQuery: properties: end_time: @@ -2887,11 +3493,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string metrics: description: 'The details of the point metric. Metrics need to specified @@ -2917,6 +3523,14 @@ components: view: $ref: '#/components/schemas/View' description: View + required: + - view + - interval + - filter + - metrics + - start_time + - name + - end_time PointMetricsResponse: properties: interval: @@ -2943,6 +3557,11 @@ components: description: 'The individual and summary views. ' + required: + - start_time + - interval + - view + - metrics PointMetricsSites: properties: data: @@ -2963,6 +3582,10 @@ components: items: $ref: '#/components/schemas/PointMetricsWanPath' type: array + required: + - data + - waninterfaces + - site_id PointMetricsWanPath: properties: anynetlinks: @@ -2982,6 +3605,10 @@ components: ' type: string + required: + - data + - anynetlinks + - wn_path_id QosMetricsFilter: properties: direction: @@ -3035,6 +3662,10 @@ components: required: - traffic_type - priority + - waninterface + - direction + - site + - element QosMetricsQuery: properties: end_time: @@ -3053,11 +3684,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string max_datapoints: description: 'The max data points. @@ -3088,8 +3719,13 @@ components: ' required: - filter + - view + - max_datapoints - interval - metrics + - start_time + - name + - end_time QosMetricsResponse: properties: metrics: @@ -3099,6 +3735,8 @@ components: items: $ref: '#/components/schemas/Metrics' type: array + required: + - metrics RadiusClientMetricsFilter: properties: element: @@ -3119,6 +3757,10 @@ components: description: Site type: string type: array + required: + - site + - interface + - element RadiusClientsRequest: properties: end_time: @@ -3151,6 +3793,12 @@ components: ' format: date type: string + required: + - max_datapoints + - filter + - start_time + - name + - end_time RadiusClientsResponse: properties: end_time: @@ -3172,6 +3820,10 @@ components: ' type: string + required: + - start_time + - items + - end_time RadiusMetricsFilter: properties: client_mac_address: @@ -3214,6 +3866,12 @@ components: description: Site type: string type: array + required: + - client_mac_address + - interface + - direction + - site + - element RadiusMetricsQuery: properties: end_time: @@ -3232,11 +3890,11 @@ components: description: 'Interval: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property) ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string max_datapoints: description: 'The max data points. @@ -3270,8 +3928,14 @@ components: ' required: + - filter + - view + - max_datapoints - interval - metrics + - start_time + - name + - end_time RadiusMetricsResponse: properties: metrics: @@ -3281,6 +3945,48 @@ 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: @@ -3306,6 +4012,12 @@ components: ' type: object + required: + - view + - unit + - name + - interval + - data SysMetricsFilter: properties: direction: @@ -3338,6 +4050,11 @@ components: description: Site type: string type: array + required: + - interface + - direction + - site + - element SysMetricsQuery: properties: end_time: @@ -3356,11 +4073,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string max_datapoints: description: 'The max data points. @@ -3388,8 +4105,14 @@ 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: @@ -3399,6 +4122,8 @@ components: items: $ref: '#/components/schemas/Metrics' type: array + required: + - metrics TopNComparator: properties: end_time: @@ -3426,6 +4151,10 @@ components: ' format: date type: string + required: + - measurement + - end_time + - start_time TopNGrowth: properties: compare: @@ -3453,7 +4182,10 @@ components: type: string required: - metrics + - filter + - compare - type + - limit TopNGrowthFilter: properties: app: @@ -3523,6 +4255,8 @@ components: description: Waninterface type: string type: array + required: + - direction TopNGrowthQuery: properties: end_time: @@ -3548,6 +4282,9 @@ components: ' required: - top_n + - start_time + - name + - end_time View: properties: individual: @@ -3568,9 +4305,6 @@ components: - TRAFFIC_TYPE - COMMON - CLIENT_MAC_ADDRESS - - USER - - USER_EMAIL - - RESOLUTION_QUALITY - None type: string summary: @@ -3578,6 +4312,9 @@ components: ' type: boolean + required: + - individual + - summary info: contact: {} description: List of APIs used to retrieve SDWAN metrics such as badnwidth utilization, @@ -3806,56 +4543,6 @@ paths: summary: Query Radius Metrics Top N (v2.0) tags: - Metrics - /v2.0/api/tenants/{tenant_id}/monitor/aggregates/application/qos: - post: - description: The aggregated data for an application's QOS stats. - operationId: post-v2.0-api-tenants-tenant_id-monitor-aggregates-application-qos - 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/ApplicationQosAggregatesQuery' - description: Filters for application qos aggregates - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AggregatesQueryResponse' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: REQUIRED_PROPERTY - - code: INVALID_STATS_REQUEST_BODY - - code: INVALID_FILTER - - code: APPLICATION_NOT_SUPPORTED - - code: MULTIPLE_QOS_TYPE_NOT_SUPPORTED - - code: REQUESTED_METRIC_NOT_SUPPORTED - - code: REQUESTED_METRIC_UNIT_NOT_SUPPORTED - - code: REQUESTED_METRIC_STATISTICS_NOT_SUPPORTED - - code: REQUESTED_VIEW_NOT_SUPPORTED - - code: START_TIME_GREATER_THAN_END_TIME - - code: OTHER_METRICS_NOT_SUPPORTED - - code: REQUESTED_VIEW_NOT_SUPPORTED_FOR_METRIC - - code: SERVICE_UNAVAILABLE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Application QOS Aggregates (2.0) - tags: - - Metrics /v2.0/api/tenants/{tenant_id}/monitor/aggregates/multicast/mroute: post: description: Query all the multicast statistics. @@ -4032,77 +4719,6 @@ paths: summary: Query Site or Path Level Aggregated Statistics (2.0) tags: - Metrics - /v2.0/api/tenants/{tenant_id}/monitor/aiops/anomaly: - get: - description: Get circuit bandwidth anomaly. - operationId: get-v2.0-api-tenants-tenant_id-monitor-aiops-anomaly - 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/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: 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 - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - 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: Get Circuit Bandwidth Anomaly for Site (v2.0) - tags: - - Metrics /v2.0/api/tenants/{tenant_id}/monitor/aiops/forecast: get: description: List all the capacity prediction schema. @@ -4321,20 +4937,10 @@ paths: - Metrics /v2.0/api/tenants/{tenant_id}/monitor/aiops/topn: post: - description: 'Get TopN sites or circuits based on growth. - - Note - - * Start and end time need to be specified in ISO8601 UTC format. - - * Metrics need to specified according to 2.0 specifications. - - * Filters need to be specified according to the specifications. - - ' + description: List all the top N data with metrics output. operationId: post-v2.0-api-tenants-tenant_id-monitor-aiops-topn parameters: - - description: Tenant Id + - description: The tenant ID. in: path name: tenant_id required: true @@ -4367,33 +4973,27 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get TopN data with metrics output (v2.0) + summary: Get Top N Data with Metrics (2.0) tags: - Metrics - /v2.0/api/tenants/{tenant_id}/monitor/application/qos_metrics: - post: - description: Query the time series application QOS metrics. - operationId: post-v2.0-api-tenants-tenant_id-monitor-application-qos_metrics + /v2.0/api/tenants/{tenant_id}/monitor/cellular_metrics: + get: + description: List all the cellular metrics schema. + operationId: get-v2.0-api-tenants-tenant_id-monitor-cellular_metrics 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/ApplicationQosMetricsQuery' - description: Filters for application qos metrics responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ApplicationQosMetricsResponse' + $ref: '#/components/schemas/CellularmetricsSchemaResponse' description: Successful Operation '400': content: @@ -4401,70 +5001,78 @@ paths: example: value: _error: - - code: REQUIRED_PROPERTY - - code: INVALID_STATS_REQUEST_BODY - - code: INVALID_FILTER - - code: APPLICATION_NOT_SUPPORTED - - code: MULTIPLE_QOS_TYPE_NOT_SUPPORTED - - code: REQUESTED_METRIC_NOT_SUPPORTED - - code: REQUESTED_METRIC_UNIT_NOT_SUPPORTED - - code: REQUESTED_METRIC_STATISTICS_NOT_SUPPORTED - - code: MAX_DATAPOINTS_NOT_SUPPORTED - - code: REQUESTED_VIEW_NOT_SUPPORTED - - code: START_TIME_GREATER_THAN_END_TIME - - code: OTHER_METRICS_NOT_SUPPORTED - - code: REQUESTED_VIEW_NOT_SUPPORTED_FOR_METRIC - - code: MOS_METRICS_NOT_SUPPORTED - - code: SERVICE_UNAVAILABLE + - code: UNSUPPORTED_SCHEMA_VERSION schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Time Series Application QOS Metrics (2.0) + summary: Get Cellular Metrics Schema (v2.0) tags: - Metrics - /v2.0/api/tenants/{tenant_id}/monitor/application/qos_metrics/{application_name}: - get: - description: Get details of application QoS metrics. - operationId: get-v2.0-api-tenants-tenant_id-monitor-application-qos_metrics-application_name + post: + description: Get cellular metrics like Signal-to Noise Ratio (SNR) and cellular + bandwidth usage. + operationId: post-v2.0-api-tenants-tenant_id-monitor-cellular_metrics 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 application name. - in: path - name: application_name - required: true - schema: - description: Application Name - type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CellularmetricsQuery' + description: Query request for getting cellularmetrics responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MetricSchemaResponse' + $ref: '#/components/schemas/CellularmetricsResponse' description: Successful Operation - '404': + '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 + - code: VERSION_NOT_SUPPORTED + - code: METRIC_STATISTICS_NOT_SUPPORTED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '500': content: application/json: example: value: _error: - - code: APPLICATION_NOT_SUPPORTED + - code: SERVER_ERROR schema: $ref: '#/components/schemas/Error' - description: Not Found - summary: Get Application QOS Metrics (2.0) + description: Internal Server Error + summary: Query Cellular Metrics (v2.0) tags: - Metrics - /v2.0/api/tenants/{tenant_id}/monitor/application/users: + /v2.0/api/tenants/{tenant_id}/monitor/cellular_metrics/topn: post: - description: Query the application users. - operationId: post-v2.0-api-tenants-tenant_id-monitor-application-users + description: Query the topn n cellular metrics. + operationId: post-v2.0-api-tenants-tenant_id-monitor-cellular_metrics-topn parameters: - description: The tenant ID. in: path @@ -4477,14 +5085,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ApplicationUsersQuery' - description: Filters for application qos point metrics + $ref: '#/components/schemas/BaseTopNQuery' + description: Filter for top N responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ApplicationUsersResponse' + $ref: '#/components/schemas/BaseTopNResponse' description: Successful Operation '400': content: @@ -4492,53 +5100,29 @@ paths: example: value: _error: - - code: REQUIRED_PROPERTY - - code: INVALID_STATS_REQUEST_BODY - - code: APPLICATION_NOT_SUPPORTED + - 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: SERVICE_UNAVAILABLE + - code: PATH_NOT_SUPPORTED_WITH_PATH_TYPE + - code: TOPN_BASIS_NOT_SUPPORTED_WITHOUT_FILTER + - code: INVALID_LIMIT + - code: TOPN_BASIS_REQUIRED + - code: TOP_N_REQUIRED + - code: TOPN_TYPE_REQUIRED + - code: PATH_TYPE_LIST_LENGTH_EXCEEDED + - code: FILTER_NOT_SUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Application Users (2.0) - tags: - - Metrics - /v2.0/api/tenants/{tenant_id}/monitor/cellular_metrics: - get: - description: List all the cellular metrics schema. - operationId: get-v2.0-api-tenants-tenant_id-monitor-cellular_metrics - 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/CellularmetricsSchemaResponse' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: UNSUPPORTED_SCHEMA_VERSION - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Cellular Metrics Schema (v2.0) + summary: Query Topn N Cellular Metrics (2.0) tags: - Metrics + /v2.0/api/tenants/{tenant_id}/monitor/lqm_point_metrics: post: - description: Get cellular metrics like Signal-to Noise Ratio (SNR) and cellular - bandwidth usage. - operationId: post-v2.0-api-tenants-tenant_id-monitor-cellular_metrics + description: Query all the link quality point metrics. + operationId: post-v2.0-api-tenants-tenant_id-monitor-lqm_point_metrics parameters: - description: ID of the tenant. in: path @@ -4551,14 +5135,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CellularmetricsQuery' - description: Query request for getting cellularmetrics + $ref: '#/components/schemas/PointMetricsQuery' + description: Query request for getting lqm metrics responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CellularmetricsResponse' + $ref: '#/components/schemas/PointMetricsResponse' description: Successful Operation '400': content: @@ -4569,39 +5153,20 @@ paths: - 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 - - code: VERSION_NOT_SUPPORTED - - code: METRIC_STATISTICS_NOT_SUPPORTED + - code: FUTURE_TIME_ERROR schema: $ref: '#/components/schemas/Error' description: Bad Request - '500': - content: - application/json: - example: - value: - _error: - - code: SERVER_ERROR - schema: - $ref: '#/components/schemas/Error' - description: Internal Server Error - summary: Query Cellular Metrics (v2.0) + summary: Query LQM Point Metrics (v2.0) tags: - Metrics - /v2.0/api/tenants/{tenant_id}/monitor/cellular_metrics/topn: + /v2.0/api/tenants/{tenant_id}/monitor/network_point_metrics: post: - description: Query the topn n cellular metrics. - operationId: post-v2.0-api-tenants-tenant_id-monitor-cellular_metrics-topn + description: Query the network point metrics bandwidth usage for all sites across + tenants. + operationId: post-v2.0-api-tenants-tenant_id-monitor-network_point_metrics parameters: - - description: The tenant ID. + - description: ID of the tenant. in: path name: tenant_id required: true @@ -4612,14 +5177,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BaseTopNQuery' - description: Filter for top N + $ref: '#/components/schemas/NetworkPointMetricsQuery' + description: Query request for getting network point metrics responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BaseTopNResponse' + $ref: '#/components/schemas/NetworkPointMetricsResponse' description: Successful Operation '400': content: @@ -4628,70 +5193,26 @@ paths: 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: TOPN_BASIS_REQUIRED - - code: TOP_N_REQUIRED - - code: TOPN_TYPE_REQUIRED - - code: PATH_TYPE_LIST_LENGTH_EXCEEDED - - code: FILTER_NOT_SUPPORTED + - code: METRIC_NOT_SUPPORTED + - code: METRIC_UNIT_NOT_SUPPORTED + - code: VERSION_NOT_SUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Topn N Cellular Metrics (2.0) - tags: - - Metrics - /v2.0/api/tenants/{tenant_id}/monitor/lqm_point_metrics: - post: - description: Query all the link quality point metrics. - operationId: post-v2.0-api-tenants-tenant_id-monitor-lqm_point_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/PointMetricsQuery' - description: Query request for getting lqm metrics - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PointMetricsResponse' - 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 LQM Point Metrics (v2.0) + description: Internal Server Error + summary: Query Network Point Metrics Bandwidth Usage (v2.0) tags: - Metrics - /v2.0/api/tenants/{tenant_id}/monitor/network_point_metrics: + /v2.0/api/tenants/{tenant_id}/monitor/network_point_metrics_bw: post: description: Query the network point metrics bandwidth usage for all sites across tenants. - operationId: post-v2.0-api-tenants-tenant_id-monitor-network_point_metrics + operationId: post-v2.0-api-tenants-tenant_id-monitor-network_point_metrics_bw parameters: - description: ID of the tenant. in: path @@ -4735,13 +5256,13 @@ paths: summary: Query Network Point Metrics Bandwidth Usage (v2.0) tags: - Metrics - /v2.0/api/tenants/{tenant_id}/monitor/network_point_metrics_bw: + /v2.0/api/tenants/{tenant_id}/monitor/network_point_metrics_hs: post: - description: Query the network point metrics bandwidth usage for all sites across + description: Query network point metrics like health score for sites across tenants. - operationId: post-v2.0-api-tenants-tenant_id-monitor-network_point_metrics_bw + operationId: post-v2.0-api-tenants-tenant_id-monitor-network_point_metrics_hs parameters: - - description: ID of the tenant. + - description: The tenant ID. in: path name: tenant_id required: true @@ -4769,7 +5290,6 @@ paths: _error: - code: INVALID_REQUEST_ERROR_0001 - code: METRIC_NOT_SUPPORTED - - code: METRIC_UNIT_NOT_SUPPORTED - code: VERSION_NOT_SUPPORTED schema: $ref: '#/components/schemas/Error' @@ -4780,16 +5300,36 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Query Network Point Metrics Bandwidth Usage (v2.0) + summary: Query Network Point Metrics HealthScore (2.0) + tags: + - Metrics + /v2.0/api/tenants/{tenant_id}/monitor/object_stats: + get: + description: Get object stats API v2.0 + operationId: get-v2.0-api-tenants-tenant_id-monitor-object_stats + parameters: + - description: Tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStatsTypeResponse' + description: Successful Operation + summary: Get name and description of all object stats tags: - Metrics - /v2.0/api/tenants/{tenant_id}/monitor/network_point_metrics_hs: post: - description: Query network point metrics like health score for sites across - tenants. - operationId: post-v2.0-api-tenants-tenant_id-monitor-network_point_metrics_hs + description: Query and get object stats API v2.0 + operationId: post-v2.0-api-tenants-tenant_id-monitor-object_stats parameters: - - description: The tenant ID. + - description: Tenant ID in: path name: tenant_id required: true @@ -4800,14 +5340,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworkPointMetricsQuery' - description: Query request for getting network point metrics + $ref: '#/components/schemas/ObjectStatsQuery' + description: Details of object stats query responses: '200': content: application/json: schema: - $ref: '#/components/schemas/NetworkPointMetricsResponse' + $ref: '#/components/schemas/ObjectStatsResponse' description: Successful Operation '400': content: @@ -4816,26 +5356,31 @@ paths: value: _error: - code: INVALID_REQUEST_ERROR_0001 - - code: METRIC_NOT_SUPPORTED - - code: VERSION_NOT_SUPPORTED + - 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 - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Internal Server Error - summary: Query Network Point Metrics HealthScore (2.0) + summary: Query and get object statistics tags: - Metrics /v2.0/api/tenants/{tenant_id}/monitor/qos_metrics: get: - description: Get details of Qos metrics + description: List the details of the QoS metrics. operationId: get-v2.0-api-tenants-tenant_id-monitor-qos_metrics parameters: - - description: Tenant ID + - description: ID of the tenant. in: path name: tenant_id required: true @@ -4849,7 +5394,7 @@ paths: schema: $ref: '#/components/schemas/MetricSchemaResponse' description: Successful Operation - summary: Get details of Qos metrics (v2.0) + summary: Get QoS Metrics (v2.0) tags: - Metrics post: @@ -4897,62 +5442,51 @@ paths: summary: Query QoS Metrics (v2.0) tags: - Metrics - /v2.0/api/tenants/{tenant_id}/monitor/sys_metrics/topn: - post: - description: Query the details of the system metrics Top N. - operationId: post-v2.0-api-tenants-tenant_id-monitor-sys_metrics-topn + /v2.0/api/tenants/{tenant_id}/monitor/sys_metrics: + get: + description: 'Returns sysmetrics schema for Version 2.0 + + ' + operationId: get-v2.0-api-tenants-tenant_id-monitor-sys_metrics parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BaseTopNQuery' - description: Filter for top N responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BaseTopNResponse' + $ref: '#/components/schemas/MetricSchemaResponse' 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.0) + description: Internal Server Error + summary: Returns sysmetrics schema for Version 2.0 tags: - Metrics - /v2.0/api/tenants/{tenant_id}/monitor/sys_point_metrics: post: - description: Query the details of the system point metrics. - operationId: post-v2.0-api-tenants-tenant_id-monitor-sys_point_metrics + description: "Get system metrics like CPU, Memory and Disk usage. External API\ + \ used for stats queries. Below 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-v2.0-api-tenants-tenant_id-monitor-sys_metrics parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true @@ -4963,14 +5497,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PointMetricsQuery' + $ref: '#/components/schemas/SysMetricsQuery' description: Query request for getting sysmetrics responses: '200': content: application/json: schema: - $ref: '#/components/schemas/PointMetricsResponse' + $ref: '#/components/schemas/SysMetricsResponse' description: Successful Operation '400': content: @@ -4981,46 +5515,82 @@ paths: - code: INVALID_REQUEST_ERROR_0001 - code: SCHEMA_MISMATCH - code: METRIC_NOT_SUPPORTED - - code: FUTURE_TIME_ERROR + - 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: MAX_DATAPOINTS_END_TIME schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query System Point Metrics (v2.0) + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal Server Error + summary: System metrics tags: - Metrics - /v2.1/api/tenants/{tenant_id}/monitor/aiops/aggregates: - get: - description: Get the site or path level aggregated statistics. - operationId: get-v2.1-api-tenants-tenant_id-monitor-aiops-aggregates + /v2.0/api/tenants/{tenant_id}/monitor/sys_metrics/topn: + post: + description: Query the details of the system metrics Top N. + operationId: post-v2.0-api-tenants-tenant_id-monitor-sys_metrics-topn 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/BaseTopNQuery' + description: Filter for top N responses: '200': content: application/json: schema: - $ref: '#/components/schemas/AggregateStatsResponse' + $ref: '#/components/schemas/BaseTopNResponse' description: Successful Operation - '500': + '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: Internal Server Error - summary: Get Site or Path Level Aggregated Statistics (2.1) + description: Bad Request + summary: Query System Metrics Top N (v2.0) tags: - Metrics + /v2.0/api/tenants/{tenant_id}/monitor/sys_point_metrics: post: - description: Query the site or path level aggregated statistics. - operationId: post-v2.1-api-tenants-tenant_id-monitor-aiops-aggregates + description: Query the details of the system point metrics. + operationId: post-v2.0-api-tenants-tenant_id-monitor-sys_point_metrics parameters: - - description: The tenant ID. + - description: ID of the tenant. in: path name: tenant_id required: true @@ -5031,14 +5601,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AggregateStatsQuery' - description: Details of app object stats query + $ref: '#/components/schemas/PointMetricsQuery' + description: Query request for getting sysmetrics responses: '200': content: application/json: schema: - $ref: '#/components/schemas/AggregateStatsResponse' + $ref: '#/components/schemas/PointMetricsResponse' description: Successful Operation '400': content: @@ -5047,21 +5617,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: METRIC_NOT_SUPPORTED + - code: FUTURE_TIME_ERROR schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Site or Path Level Aggregated Statistics (2.1) + summary: Query System Point Metrics (v2.0) tags: - Metrics /v2.1/api/tenants/{tenant_id}/monitor/aiops/forecast: @@ -5209,15 +5771,141 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query and get App object statistics (v2.1) + summary: Query and get App object statistics + tags: + - Metrics + /v2.1/api/tenants/{tenant_id}/monitor/metrics: + post: + description: Query and get monitor metrics API v2.1 + operationId: post-v2.1-api-tenants-tenant_id-monitor-metrics + 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/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 + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query and get monitor metrics + tags: + - Metrics + /v2.1/api/tenants/{tenant_id}/monitor/metrics/{mtype}: + get: + description: Get details of monitor metrics API v2.1 + operationId: get-v2.1-api-tenants-tenant_id-monitor-metrics-mtype + parameters: + - description: Tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: 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 details of monitor metrics + tags: + - Metrics + /v2.1/api/tenants/{tenant_id}/monitor/object_stats: + get: + description: Get object stats API v2.1 + operationId: get-v2.1-api-tenants-tenant_id-monitor-object_stats + parameters: + - description: Tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStatsTypeResponse' + description: Successful Operation + summary: Get name and description of all object stats tags: - Metrics - /v2.1/api/tenants/{tenant_id}/monitor/sys_metrics/topn: post: - description: Query the details of the system metrics Top N. - operationId: post-v2.1-api-tenants-tenant_id-monitor-sys_metrics-topn + description: Query and get object stats API v2.1 + operationId: post-v2.1-api-tenants-tenant_id-monitor-object_stats parameters: - - description: ID of the tenant. + - description: Tenant ID in: path name: tenant_id required: true @@ -5228,14 +5916,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BaseTopNQuery' - description: Filter for top N + $ref: '#/components/schemas/ObjectStatsQuery' + description: Details of object stats query responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BaseTopNResponse' + $ref: '#/components/schemas/ObjectStatsResponse' description: Successful Operation '400': content: @@ -5244,30 +5932,33 @@ paths: 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 + - 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 System Metrics Top N (v2.1) + summary: Query and get object statistics tags: - Metrics - /v2.2/api/tenants/{tenant_id}/monitor/sys_metrics: + /v2.1/api/tenants/{tenant_id}/monitor/sys_metrics: get: - description: List all the system metrics schema. - operationId: get-v2.2-api-tenants-tenant_id-monitor-sys_metrics + description: 'Returns sysmetrics schema for Version 2.1 + + ' + operationId: get-v2.1-api-tenants-tenant_id-monitor-sys_metrics parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true @@ -5287,25 +5978,25 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Get System Metrics Schema (v2.2) + summary: Returns sysmetrics schema for Version 2.1 tags: - Metrics post: description: "Get system metrics like CPU, Memory and Disk usage. External API\ \ used for stats queries. In addition to __CPUUsage__, Memory Usage and DiskUsage\n\ - __InterfaceBandwidthUsage, InterfaceDroppedPackets, InterfaceErrors, InterfaceFifoErrors,\ - \ InterfaceIngressCRCErrors, InterfaceIngressFrameErrors, InterfaceEgressCarrierErrors__\n\ - additional metrics like __InterfacePoePowerConsumption__\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-v2.2-api-tenants-tenant_id-monitor-sys_metrics + additional metrics like __InterfaceBandwidthUsage, InterfaceDroppedPackets,\ + \ InterfaceErrors, InterfaceFifoErrors, InterfaceIngressCRCErrors, InterfaceIngressFrameErrors,\ + \ InterfaceEgressCarrierErrors__\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-v2.1-api-tenants-tenant_id-monitor-sys_metrics parameters: - description: Tenant Id in: path @@ -5354,13 +6045,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: System metrics for Version 2.2 (v2.2) + summary: System metrics for Version 2.1 tags: - Metrics - /v2.3/api/tenants/{tenant_id}/monitor/metrics: + /v2.1/api/tenants/{tenant_id}/monitor/sys_metrics/topn: post: - description: Query all the monitor metrics. - operationId: post-v2.3-api-tenants-tenant_id-monitor-metrics + description: Query the details of the system metrics Top N. + operationId: post-v2.1-api-tenants-tenant_id-monitor-sys_metrics-topn parameters: - description: ID of the tenant. in: path @@ -5369,6 +6060,56 @@ paths: schema: description: Tenant Id type: string + 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.1) + tags: + - Metrics + /v2.2/api/tenants/{tenant_id}/monitor/metrics: + post: + description: Query and get monitor metrics API v2.2 + operationId: post-v2.2-api-tenants-tenant_id-monitor-metrics + parameters: + - description: Tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string requestBody: content: application/json: @@ -5393,7 +6134,6 @@ 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 @@ -5420,22 +6160,22 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Monitor Metrics (v2.3) + summary: Query and get monitor metrics tags: - Metrics - /v2.3/api/tenants/{tenant_id}/monitor/metrics/{mtype}: + /v2.2/api/tenants/{tenant_id}/monitor/metrics/{mtype}: get: - description: List details of the monitor metrics. - operationId: get-v2.3-api-tenants-tenant_id-monitor-metrics-mtype + description: Get details of monitor metrics API v2.2 + operationId: get-v2.2-api-tenants-tenant_id-monitor-metrics-mtype parameters: - - description: ID of the tenant. + - description: Tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The metric type. + - description: Metric Type in: path name: mtype required: true @@ -5459,15 +6199,87 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Monitor Metrics (v2.3) + summary: Get details of monitor metrics + tags: + - Metrics + /v2.2/api/tenants/{tenant_id}/monitor/object_stats: + get: + description: Get object stats API v2.2 + operationId: get-v2.2-api-tenants-tenant_id-monitor-object_stats + parameters: + - description: Tenant ID + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStatsTypeResponse' + description: Successful Operation + summary: Get name and description of all object statistics tags: - Metrics - /v2.3/api/tenants/{tenant_id}/monitor/sys_metrics: + post: + description: Query and get object stats API v2.2 + operationId: post-v2.2-api-tenants-tenant_id-monitor-object_stats + 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/ObjectStatsQuery' + description: Details of 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 and get object statistics + tags: + - Metrics + /v2.2/api/tenants/{tenant_id}/monitor/sys_metrics: get: - description: 'Returns sysmetrics schema for Version 2.3 + description: 'Returns sysmetrics schema for Version 2.2 ' - operationId: get-v2.3-api-tenants-tenant_id-monitor-sys_metrics + operationId: get-v2.2-api-tenants-tenant_id-monitor-sys_metrics parameters: - description: Tenant Id in: path @@ -5489,12 +6301,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Returns sysmetrics schema for Version 2.3 (v2.3) + summary: Returns sysmetrics schema for Version 2.2 tags: - Metrics post: description: List all the system metrics schema. - operationId: post-v2.3-api-tenants-tenant_id-monitor-sys_metrics + operationId: post-v2.2-api-tenants-tenant_id-monitor-sys_metrics parameters: - description: ID of the tenant. in: path @@ -5543,13 +6355,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Get System Metrics Schema (v2.3) + summary: Get System Metrics Schema (v2.2) tags: - Metrics - /v2.4/api/tenants/{tenant_id}/monitor/metrics: + /v2.3/api/tenants/{tenant_id}/monitor/metrics: post: description: Query all the monitor metrics. - operationId: post-v2.4-api-tenants-tenant_id-monitor-metrics + operationId: post-v2.3-api-tenants-tenant_id-monitor-metrics parameters: - description: ID of the tenant. in: path @@ -5606,17 +6418,16 @@ 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.4) + summary: Query Monitor Metrics (v2.3) tags: - Metrics - /v2.4/api/tenants/{tenant_id}/monitor/metrics/{mtype}: + /v2.3/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 + operationId: get-v2.3-api-tenants-tenant_id-monitor-metrics-mtype parameters: - description: ID of the tenant. in: path @@ -5649,15 +6460,15 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Monitor Metrics (v2.4) + summary: Get Monitor Metrics (v2.3) tags: - Metrics - /v2.4/api/tenants/{tenant_id}/monitor/object_stats: + /v2.3/api/tenants/{tenant_id}/monitor/object_stats: get: - description: List the object statistics. - operationId: get-v2.4-api-tenants-tenant_id-monitor-object_stats + description: Get object stats API v2.3 + operationId: get-v2.3-api-tenants-tenant_id-monitor-object_stats parameters: - - description: ID of the tenant. + - description: Tenant ID in: path name: tenant_id required: true @@ -5671,14 +6482,14 @@ paths: schema: $ref: '#/components/schemas/ObjectStatsTypeResponse' description: Successful Operation - summary: Get Object Stats (v2.4) + summary: Get name and description of all object statistics tags: - Metrics post: - description: Query and get object statistics. - operationId: post-v2.4-api-tenants-tenant_id-monitor-object_stats + description: Query and get object stats API v2.3 + operationId: post-v2.3-api-tenants-tenant_id-monitor-object_stats parameters: - - description: ID of the tenant. + - description: Tenant ID in: path name: tenant_id required: true @@ -5721,13 +6532,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Object Stats (v2.4) + summary: Query and get object statistics tags: - Metrics - /v2.5/api/tenants/{tenant_id}/monitor/object_stats: + /v2.4/api/tenants/{tenant_id}/monitor/object_stats: get: description: List the object statistics. - operationId: get-v2.5-api-tenants-tenant_id-monitor-object_stats + operationId: get-v2.4-api-tenants-tenant_id-monitor-object_stats parameters: - description: ID of the tenant. in: path @@ -5743,12 +6554,12 @@ paths: schema: $ref: '#/components/schemas/ObjectStatsTypeResponse' description: Successful Operation - summary: Get Object Stats (v2.5) + summary: Get Object Stats (v2.4) tags: - Metrics post: description: Query and get object statistics. - operationId: post-v2.5-api-tenants-tenant_id-monitor-object_stats + operationId: post-v2.4-api-tenants-tenant_id-monitor-object_stats parameters: - description: ID of the tenant. in: path @@ -5793,7 +6604,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Object Stats (v2.5) + summary: Query Object Stats (v2.4) tags: - Metrics /v3.0/api/tenants/{tenant_id}/monitor/aggregates: @@ -5964,12 +6775,12 @@ paths: summary: Get Top N Data (v3.1) tags: - Metrics - /v3.7/api/tenants/{tenant_id}/monitor/flows: + /v3.4/api/tenants/{tenant_id}/monitor/flows: post: - description: List all the flows information. - operationId: post-v3.7-api-tenants-tenant_id-monitor-flows + description: Get flows information for v3.4 + operationId: post-v3.4-api-tenants-tenant_id-monitor-flows parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true @@ -6016,15 +6827,70 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Get Flows Information (v3.7) + summary: Flows tags: - Metrics - /v3.8/api/tenants/{tenant_id}/monitor/flows: + /v3.5/api/tenants/{tenant_id}/monitor/flows: post: - description: List all the flows information. - operationId: post-v3.8-api-tenants-tenant_id-monitor-flows + description: Get flows information for v3.5 + operationId: post-v3.5-api-tenants-tenant_id-monitor-flows parameters: - - description: ID of the tenant. + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FlowsQuery' + description: Filter for flows + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FlowsQueryResponse' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: EMPTY_REQ_BODY + - code: SCHEMA_MISMATCH + - code: START_TIME_GREATER_THAN_END_TIME + - code: INVALID_REQUEST_ERROR_0001 + - code: EMPTY_FILTER + - code: PATH_AND_PATH_TYPE_NOT_SUPPORTED + - code: SITE_WITH_PATH_MISSING + - code: SITE_WITH_WANINTERFACE_MISSING + - code: SITE_WITH_ELEMENT_MISSING + - code: SITE_WITH_FLOW_TUPLE_MISSING + - code: INVALID_IP + - code: INVALID_FLOW_TYPE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal Server Error + summary: Flows + tags: + - Metrics + /v3.6/api/tenants/{tenant_id}/monitor/flows: + post: + description: Get flows information for v3.6 + operationId: post-v3.6-api-tenants-tenant_id-monitor-flows + parameters: + - description: Tenant Id in: path name: tenant_id required: true @@ -6071,7 +6937,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Get Flows Information (v3.8) + summary: Flows tags: - Metrics servers: diff --git a/openapi-specs/sdwan/legacy/Multicast.yaml b/openapi-specs/sdwan/legacy/Multicast.yaml index 78f90d645..d33bb46e8 100644 --- a/openapi-specs/sdwan/legacy/Multicast.yaml +++ b/openapi-specs/sdwan/legacy/Multicast.yaml @@ -2,21 +2,9 @@ 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: @@ -26,28 +14,6 @@ components: - 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 DynamicRp: properties: groups: diff --git a/openapi-specs/sdwan/legacy/NATPolicy.yaml b/openapi-specs/sdwan/legacy/NATPolicy.yaml index 9b382b77b..5aa79bc76 100644 --- a/openapi-specs/sdwan/legacy/NATPolicy.yaml +++ b/openapi-specs/sdwan/legacy/NATPolicy.yaml @@ -2,21 +2,9 @@ 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: @@ -26,28 +14,6 @@ components: - 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 BasePolicyPrefixS: properties: description: @@ -65,12 +31,6 @@ components: description: Ipv4 Prefixes type: string type: array - ipv6_prefixes: - description: Ipv6 Prefixes - items: - description: Ipv6 Prefixes - type: string - type: array name: description: "The name of the source/destination prefix. \n" type: string diff --git a/openapi-specs/sdwan/legacy/NetworkConstructs.yaml b/openapi-specs/sdwan/legacy/NetworkConstructs.yaml index 472e34596..cbb98be4e 100644 --- a/openapi-specs/sdwan/legacy/NetworkConstructs.yaml +++ b/openapi-specs/sdwan/legacy/NetworkConstructs.yaml @@ -2,21 +2,9 @@ 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: @@ -26,28 +14,6 @@ components: - 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 BaseCustomDHCPOptions: properties: option_definition: @@ -233,9 +199,6 @@ 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. @@ -243,9 +206,6 @@ components: ' format: int32 type: integer - lifetime_units: - description: Lifetime Units - type: string mode: description: 'The IPsec config ESP tunnel mode. @@ -261,10 +221,8 @@ components: items: $ref: '#/components/schemas/Proposals' type: array - responder_sase_proposals: - $ref: '#/components/schemas/ResponderSaseProposals' - description: Responder Sase Proposals required: + - proposals - mode Error: properties: @@ -292,9 +250,6 @@ components: ' type: boolean - authentication_multiple: - description: Authentication Multiple - type: integer key_exchange: description: 'The key exchange for the IKE group = IKEv1 or IKEv2. @@ -310,9 +265,6 @@ 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 @@ -337,6 +289,7 @@ components: ' type: boolean required: + - proposals - key_exchange IKEV1Params: properties: @@ -388,12 +341,6 @@ 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 ' @@ -410,34 +357,18 @@ 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. @@ -463,9 +394,6 @@ 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. @@ -710,6 +638,41 @@ components: - ike_group - esp_group - name + LANNetwork: + properties: + id: + description: "The ID of the LAN network. \n" + type: string + ipv4_config: + $ref: '#/components/schemas/LanNetworkIPv4Config' + description: 'The Ipv4 config of the LAN network. Maz size = 256. + + ' + name: + description: 'The name of the LAN network. Max size = 128. + + ' + type: string + network_context_id: + description: 'The network context ID. + + ' + type: string + scope: + description: "The scope of the network. \n" + enum: + - GLOBAL + - LOCAL + type: string + security_policy_set: + $ref: '#/components/schemas/SecurityPolicySet' + description: 'The details of the security policy set configured for the + network. + + ' + required: + - scope + - name LANNetworkQuery: properties: aggregate: @@ -780,6 +743,41 @@ components: ' format: int64 type: integer + LANNetworkQueryFilter: + properties: + id: + description: "The ID of the LAN network. \n" + type: string + ipv4_config: + $ref: '#/components/schemas/LanNetworkIPv4Config' + description: 'The Ipv4 config of the LAN network. Maz size = 256. + + ' + name: + description: 'The name of the LAN network. Max size = 128. + + ' + type: string + network_context_id: + description: 'The network context ID. + + ' + type: string + scope: + description: "The scope of the network. \n" + enum: + - GLOBAL + - LOCAL + type: string + security_policy_set: + $ref: '#/components/schemas/SecurityPolicySet' + description: 'The details of the security policy set configured for the + network. + + ' + required: + - scope + - name LANNetworkQueryFilterResponse: properties: description: @@ -830,7 +828,7 @@ components: - site_id - scope - name - LANNetworkQueryFilterV3N2: + LANNetworkQueryFilterV3N1: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -843,11 +841,6 @@ 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. @@ -879,12 +872,8 @@ components: required: - scope - name - LANNetworkQueryFilterV3N3: + LANNetworkScreen: properties: - description: - description: 'The description of the LAN network. Maz size = 256. - - ' id: description: "The ID of the LAN network. \n" type: string @@ -892,11 +881,6 @@ 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. @@ -909,34 +893,22 @@ components: ' type: string scope: - description: 'The scope of the network. - - ' + description: "The scope of the network. \n" enum: - GLOBAL - 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. + security_policy_set: + $ref: '#/components/schemas/SecurityPolicySet' + description: 'The details of the security policy set configured for the + network. ' - items: - description: Tags - type: string - type: array - vrf_context_id: - description: "The vrf context id. \n" - type: string required: - scope - name - LANNetworkScreenV3N2: + LANNetworkScreenV3: properties: - description: - description: 'The description of the LAN network. Maz size = 256. - - ' id: description: "The ID of the LAN network. \n" type: string @@ -944,11 +916,6 @@ 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. @@ -968,19 +935,10 @@ components: - GLOBAL - 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. - - ' - items: - description: Tags - type: string - type: array required: - scope - name - LANNetworkScreenV3N3: + LANNetworkScreenV3N1: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -993,11 +951,6 @@ 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. @@ -1018,27 +971,17 @@ 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. - - ' + description: "An information field that can be added to identify the LAN\ + \ network. Maximum 10 unique tags of length 1024 each are allowed. \n" items: description: Tags type: string type: array - vrf_context_id: - description: "The VRF (Virtual Routing and Forwarding) ID. \ - \ \n" - type: string required: - scope - name - LANNetworkV3N2: + LANNetworkV3: properties: - description: - description: 'The description of the LAN network. Maz size = 256. - - ' id: description: "The ID of the LAN network. \n" type: string @@ -1046,11 +989,6 @@ 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. @@ -1070,19 +1008,10 @@ components: - GLOBAL - 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. - - ' - items: - description: Tags - type: string - type: array required: - scope - name - LANNetworkV3N3: + LANNetworkV3N1: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -1095,11 +1024,6 @@ 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. @@ -1128,11 +1052,6 @@ components: description: Tags type: string type: array - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. - - ' - type: string required: - scope - name @@ -1185,33 +1104,6 @@ components: description: Prefixes type: string type: array - LanNetworkIPv6Config: - properties: - default_routers: - description: 'The LAN config default routers. - - ' - items: - description: Default Routers - type: string - type: array - prefixes: - description: 'The LAN config IPv6 prefix. - - ' - items: - description: Prefixes - type: string - type: array - Lifesize: - properties: - units: - description: Units - type: string - value: - description: Value - format: int32 - type: integer ListQueryResponse: properties: count: @@ -1368,7 +1260,6 @@ components: - AES128CTR - AES192CTR - AES256CTR - - AES128CCM16 - AES128CCM64 - AES192CCM64 - AES256CCM64 @@ -1378,10 +1269,8 @@ components: - AES128CCM128 - AES192CCM128 - AES256CCM128 - - AES128GCM16 - AES128GCM64 - AES192GCM64 - - AES256GCM16 - AES256GCM64 - AES128GCM96 - AES192GCM96 @@ -1421,116 +1310,35 @@ components: - AES128GMAC - AES192GMAC - AES256GMAC - - NONE type: string required: - hash - encryption - dh_groups - ResponderSaseProposals: + SecurityPolicySet: 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. + description: + description: 'The description of the security policy set. Max size = 256. ' - 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. + id: + description: 'The security policy set ID. + + ' + type: string + name: + description: 'The name of the security policy set. Max size = 128. ' + type: string + policyrule_order: + description: "The order for the execution of the policy rule. \n" items: - description: Hash - enum: - - MD5 - - SHA1 - - SHA256 - - SHA384 - - SHA512 - - SHA256_96 - - AESXCBC - - AES128GMAC - - AES192GMAC - - AES256GMAC - - NONE + description: Policyrule Order type: string type: array + required: + - name SiteIPFixPrefixAssociation: properties: id: @@ -1573,6 +1381,7 @@ components: type: string required: - ip_address + - mac - name VPNLinkConfiguration: properties: @@ -1589,6 +1398,23 @@ components: required: - keep_alive_failure_count - keep_alive_interval + WANInterfaceLabel: + properties: + description: + description: 'The description of the WAN interface label. Maz size = 256. + + ' + id: + description: 'The ID of the WAN interface label. + + ' + type: string + label: + description: "The label of the WAN interface. \n" + type: string + name: + description: "The name of the WAN interface label. Max size = 128. \n" + type: string WANInterfaceLabelQuery: properties: aggregate: @@ -1714,7 +1540,26 @@ components: description: 'The configuration of the VPN link. ' - WANInterfaceLabelScreenV2N3: + WANInterfaceLabelScreen: + properties: + description: + description: 'The description of the WAN interface label. Maz size = 256. + + ' + id: + description: 'The ID of the WAN interface label. + + ' + type: string + label: + description: "The label of the WAN interface. \n" + type: string + name: + description: 'The name of the WAN interface label. Max size = 128. + + ' + type: string + WANInterfaceLabelScreenV2N1: properties: description: description: 'The description of the WAN interface label. Maz size = 256. @@ -1742,25 +1587,8 @@ components: description: Tags type: string type: array - use_for_application_reachability_probes: - description: "Indicates if the use for application reachability probe is\ - \ selected. \n" - type: boolean - use_for_controller_connections: - description: 'Indicates if the use for controller connections is selected. - - ' - type: boolean - vpnlink_configuration: - $ref: '#/components/schemas/VPNLinkConfiguration' - description: 'The configuration of the VPN link. - - ' - WANInterfaceLabelScreenV2N4: + WANInterfaceLabelScreenV2N2: properties: - bwc_enabled: - description: "The bwc parameters. \n" - type: boolean description: description: 'The description of the WAN interface label. Maz size = 256. @@ -1771,13 +1599,8 @@ components: ' type: string label: - description: 'The label of the WAN interface. - - ' + description: "The label of the WAN interface. \n" type: string - lqm_enabled: - description: "The link quality monitoring parameters. \n" - type: boolean name: description: 'The name of the WAN interface label. Max size = 128. @@ -1792,10 +1615,93 @@ components: description: Tags type: string type: array - use_for_application_reachability_probes: - description: "Indicates if the use for application reachability probe is\ - \ selected. \n" - type: boolean + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + WANInterfaceLabelScreenV2N3: + properties: + description: + description: 'The description of the WAN interface label. Maz size = 256. + + ' + id: + description: 'The ID of the WAN interface label. + + ' + type: string + label: + description: "The label of the WAN interface. \n" + type: string + name: + description: 'The name of the WAN interface label. Max size = 128. + + ' + type: string + tags: + description: 'An information field that can be added to identify the WAN + interface label. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + use_for_application_reachability_probes: + description: "Indicates if the use for application reachability probe is\ + \ selected. \n" + type: boolean + use_for_controller_connections: + description: 'Indicates if the use for controller connections is selected. + + ' + type: boolean + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + WANInterfaceLabelScreenV2N4: + properties: + bwc_enabled: + description: "The bwc parameters. \n" + type: boolean + description: + description: 'The description of the WAN interface label. Maz size = 256. + + ' + id: + description: 'The ID of the WAN interface label. + + ' + type: string + label: + description: 'The label of the WAN interface. + + ' + type: string + lqm_enabled: + description: "The link quality monitoring parameters. \n" + type: boolean + name: + description: 'The name of the WAN interface label. Max size = 128. + + ' + type: string + tags: + description: 'An information field that can be added to identify the WAN + interface label. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + use_for_application_reachability_probes: + description: "Indicates if the use for application reachability probe is\ + \ selected. \n" + type: boolean use_for_controller_connections: description: 'Indicates if the use for controller connections is selected. @@ -1810,6 +1716,67 @@ components: $ref: '#/components/schemas/VPNLinkConfiguration' description: 'The configuration of the VPN link. + ' + WANInterfaceLabelV2N1: + properties: + description: + description: 'The description of the WAN interface label. Maz size = 256. + + ' + id: + description: 'The ID of the WAN interface label. + + ' + type: string + label: + description: "The label of the WAN interface. \n" + type: string + name: + description: 'The name of the WAN interface label. Max size = 128. + + ' + type: string + tags: + description: 'An information field that can be added to identify the WAN + interface label. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + WANInterfaceLabelV2N2: + properties: + description: + description: 'The description of the WAN interface label. Maz size = 256. + + ' + id: + description: 'The ID of the WAN interface label. + + ' + type: string + label: + description: "The label of the WAN interface. \n" + type: string + name: + description: 'The name of the WAN interface label. Max size = 128. + + ' + type: string + tags: + description: 'An information field that can be added to identify the WAN + interface label. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + ' WANInterfaceLabelV2N3: properties: @@ -2733,57 +2700,67 @@ paths: summary: Update LAN Segment (v2.0) tags: - Network Constructs - /v2.0/api/tenants/{tenant_id}/wannetworks: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/lannetworks: get: - description: List all the tenant WAN networks. - operationId: get-v2.0-api-tenants-tenant_id-wannetworks + description: Get LAN networks + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-lannetworks parameters: - - description: The ID of the tenant. + - description: tenant ID 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 responses: '200': content: application/json: schema: - allOf: + oneOf: + - $ref: '#/components/schemas/ListQueryResponse' - $ref: '#/components/schemas/BulkResponse' - - properties: - items: - items: - $ref: '#/components/schemas/WANNetwork' - type: array - type: object description: Successful Operation - summary: Get WAN Networks (v2.0) + summary: Get LAN networks (v2.0) tags: - Network Constructs post: - description: Create a new WAN network. - operationId: post-v2.0-api-tenants-tenant_id-wannetworks + description: Create a new LAN + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-lannetworks parameters: - - description: The ID of the tenant. + - description: tenant ID 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/WANNetworkScreen' + $ref: '#/components/schemas/LANNetworkScreen' + description: Details of the network to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANNetwork' + $ref: '#/components/schemas/LANNetwork' description: Successful Operation '400': content: @@ -2793,30 +2770,46 @@ paths: _error: - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_INPUT - - code: EXTRA_PROVIDER_ASNUM + - code: NO_LAN_NET_PREFIX + - code: ONLY_ONE_DEFAULT_ROUTER_SUPPORTED + - code: INVALID_NETWORK_CONTEXT + - code: INVALID_IPV4_PREFIX + - code: SAME_IPV4_PREFIX + - code: INVALID_IPADDRESS + - code: DEFAULT_ROUTER_PREFIX_MISMATCH + - code: SAME_IPV4_DEFAULT_ROUTER_ADDRESS + - code: INVALID_APP_ID + - code: LAN_NETWORK_ADD_FAILURE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create WAN Network (v2.0) + summary: Create a new LAN (v2.0) tags: - Network Constructs - /v2.0/api/tenants/{tenant_id}/wannetworks/query: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/lannetworks/query: post: - description: Query the DB for WAN networks that match query parameters. - operationId: post-v2.0-api-tenants-tenant_id-wannetworks-query + description: Query LAN networks that match query params + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-lannetworks-query parameters: - - description: The ID of the tenant. + - description: tenant ID 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/WANNetworkQuery' + $ref: '#/components/schemas/LANNetworkQuery' responses: '200': content: @@ -2827,48 +2820,45 @@ paths: - properties: items: items: - $ref: '#/components/schemas/WANNetworkQuery' + $ref: '#/components/schemas/LANNetworkQueryFilter' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_WAN_NETWORK_EXISTS - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query DB for WAN Networks (v2.0) + summary: Query LAN networks that match query params (v2.0) tags: - Network Constructs - /v2.0/api/tenants/{tenant_id}/wannetworks/{wan_network_id}: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/lannetworks/{lannetwork_id}: delete: - description: Delete an existing WAN network. - operationId: delete-v2.0-api-tenants-tenant_id-wannetworks-wan_network_id + description: Delete an existing LAN + operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id parameters: - - description: The ID of the tenant. + - description: tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the WAN network. + - description: site ID in: path - name: wan_network_id + name: site_id required: true schema: - description: Wan Network Id + description: Site Id + type: string + - description: LAN network ID + in: path + name: lannetwork_id + required: true + schema: + description: Lannetwork Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANNetwork' + $ref: '#/components/schemas/LANNetwork' description: Successful Operation '400': content: @@ -2876,35 +2866,452 @@ paths: example: value: _error: - - code: SITE_WAN_NETWORK_EXISTS + - code: LAN_NETWORK_IN_USE + - code: LANNETWORK_IS_USED_IN_SECURITY_ZONES schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete WAN Network (v2.0) + summary: Delete an existing LAN (v2.0) tags: - Network Constructs get: - description: List a WAN network. - operationId: get-v2.0-api-tenants-tenant_id-wannetworks-wan_network_id + description: Get LAN network + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id parameters: - - description: The ID of the tenant. + - description: tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the WAN network. + - description: site ID in: path - name: wan_network_id + name: site_id required: true schema: - description: Wan Network Id + description: Site Id type: string - responses: - '200': - content: - application/json: + - description: LAN network ID + in: path + name: lannetwork_id + required: true + schema: + description: Lannetwork Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LANNetwork' + description: Successful Operation + summary: Get LAN network (v2.0) + tags: + - Network Constructs + put: + description: Update an existing LAN + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id + parameters: + - description: tenant ID + 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: LAN network ID + in: path + name: lannetwork_id + required: true + schema: + description: Lannetwork Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LANNetworkScreen' + description: Details of the network to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LANNetwork' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: INVALID_JSON_INPUT + - code: NO_LAN_NET_PREFIX + - code: ONLY_ONE_DEFAULT_ROUTER_SUPPORTED + - code: INVALID_NETWORK_CONTEXT + - code: INVALID_IPV4_PREFIX + - code: SAME_IPV4_PREFIX + - code: INVALID_IPADDRESS + - code: DEFAULT_ROUTER_PREFIX_MISMATCH + - code: SAME_IPV4_DEFAULT_ROUTER_ADDRESS + - code: INVALID_APP_ID + - code: OVERLAPPING_LAN_NET_PREFIXES + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update an existing LAN (v2.0) + tags: + - Network Constructs + /v2.0/api/tenants/{tenant_id}/waninterfacelabels: + get: + description: Get WAN interface labels for a tenant + operationId: get-v2.0-api-tenants-tenant_id-waninterfacelabels + parameters: + - description: 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/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceLabel' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get WAN interface labels for a tenant (v2.0) + tags: + - Network Constructs + /v2.0/api/tenants/{tenant_id}/waninterfacelabels/query: + post: + description: Query db for WAN interface labels that match query parameters + operationId: post-v2.0-api-tenants-tenant_id-waninterfacelabels-query + 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/WANInterfaceLabelQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceLabelQuery' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query db for WAN interface labels that match query parameters (v2.0) + tags: + - Network Constructs + /v2.0/api/tenants/{tenant_id}/waninterfacelabels/{wantinterface_label_id}: + get: + description: Get a specific WAN interface label + operationId: get-v2.0-api-tenants-tenant_id-waninterfacelabels-wantinterface_label_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Label Id + in: path + name: wantinterface_label_id + required: true + schema: + description: Wantinterface Label Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceLabel' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get a specific WAN interface label (v2.0) + tags: + - Network Constructs + put: + description: Update specific WAN interface label + operationId: put-v2.0-api-tenants-tenant_id-waninterfacelabels-wantinterface_label_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Label Id + in: path + name: wantinterface_label_id + required: true + schema: + description: Wantinterface Label Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceLabelScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceLabel' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: WAN_INTERFACE_LABEL_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update specific WAN interface label (v2.0) + tags: + - Network Constructs + /v2.0/api/tenants/{tenant_id}/wannetworks: + get: + description: List all the tenant WAN networks. + operationId: get-v2.0-api-tenants-tenant_id-wannetworks + parameters: + - description: The 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/WANNetwork' + type: array + type: object + description: Successful Operation + summary: Get WAN Networks (v2.0) + tags: + - Network Constructs + post: + description: Create a new WAN network. + operationId: post-v2.0-api-tenants-tenant_id-wannetworks + parameters: + - description: The 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/WANNetworkScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANNetwork' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_INPUT + - code: EXTRA_PROVIDER_ASNUM + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create WAN Network (v2.0) + tags: + - Network Constructs + /v2.0/api/tenants/{tenant_id}/wannetworks/query: + post: + description: Query the DB for WAN networks that match query parameters. + operationId: post-v2.0-api-tenants-tenant_id-wannetworks-query + parameters: + - description: The 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/WANNetworkQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANNetworkQuery' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SITE_WAN_NETWORK_EXISTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for WAN Networks (v2.0) + tags: + - Network Constructs + /v2.0/api/tenants/{tenant_id}/wannetworks/{wan_network_id}: + delete: + description: Delete an existing WAN network. + operationId: delete-v2.0-api-tenants-tenant_id-wannetworks-wan_network_id + parameters: + - description: The ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the WAN network. + in: path + name: wan_network_id + required: true + schema: + description: Wan Network Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANNetwork' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SITE_WAN_NETWORK_EXISTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete WAN Network (v2.0) + tags: + - Network Constructs + get: + description: List a WAN network. + operationId: get-v2.0-api-tenants-tenant_id-wannetworks-wan_network_id + parameters: + - description: The ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the WAN network. + in: path + name: wan_network_id + required: true + schema: + description: Wan Network Id + type: string + responses: + '200': + content: + application/json: schema: $ref: '#/components/schemas/WANNetwork' description: Successful Operation @@ -3130,48 +3537,219 @@ paths: name: profile_id required: true schema: - description: Profile Id + description: Profile Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPSECProfile' + description: Successful Operation + summary: Get IPSEC Profile (v2.1) + tags: + - Network Constructs + put: + description: Update an IPsec Profile. + operationId: put-v2.1-api-tenants-tenant_id-ipsecprofiles-profile_id + parameters: + - description: The ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the IPsec profile. + in: path + name: profile_id + required: true + schema: + description: Profile Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IPSECProfileScreen' + description: Details of the IPSEC profile to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPSECProfile' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_VALUE + - code: IPSECCONFIG_INVALID_ENCODED_AUTH_SECRET + - code: IPSECCONFIG_IKEGROUP_REQUIRED + - code: IPSECCONFIG_INVALID_DPD_DELAY + - code: IPSECCONFIG_ESPGROUP_REQUIRED + - code: IPSECCONFIG_AUTHENTICATION_REQUIRED + - code: IPSECCONFIG_INVALID_DPD_TIMEOUT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update IPSEC Profile (v2.1) + tags: + - Network Constructs + /v2.1/api/tenants/{tenant_id}/waninterfacelabels: + get: + description: Get WAN interface labels for a tenant + operationId: get-v2.1-api-tenants-tenant_id-waninterfacelabels + parameters: + - description: 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/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceLabelV2N1' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get WAN interface labels for a tenant (v2.1) + tags: + - Network Constructs + /v2.1/api/tenants/{tenant_id}/waninterfacelabels/query: + post: + description: Query db for WAN interface labels that match query parameters + operationId: post-v2.1-api-tenants-tenant_id-waninterfacelabels-query + 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/WANInterfaceLabelQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceLabelQuery' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query db for WAN interface labels that match query parameters (v2.1) + tags: + - Network Constructs + /v2.1/api/tenants/{tenant_id}/waninterfacelabels/{wantinterface_label_id}: + get: + description: Get a specific WAN interface label + operationId: get-v2.1-api-tenants-tenant_id-waninterfacelabels-wantinterface_label_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Label Id + in: path + name: wantinterface_label_id + required: true + schema: + description: Wantinterface Label Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/IPSECProfile' + $ref: '#/components/schemas/WANInterfaceLabelV2N1' description: Successful Operation - summary: Get IPSEC Profile (v2.1) + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get a specific WAN interface label (v2.1) tags: - Network Constructs put: - description: Update an IPsec Profile. - operationId: put-v2.1-api-tenants-tenant_id-ipsecprofiles-profile_id + description: Update specific WAN interface label + operationId: put-v2.1-api-tenants-tenant_id-waninterfacelabels-wantinterface_label_id parameters: - - description: The ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the IPsec profile. + - description: Label Id in: path - name: profile_id + name: wantinterface_label_id required: true schema: - description: Profile Id + description: Wantinterface Label Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IPSECProfileScreen' - description: Details of the IPSEC profile to be created + $ref: '#/components/schemas/WANInterfaceLabelScreenV2N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/IPSECProfile' + $ref: '#/components/schemas/WANInterfaceLabelV2N1' description: Successful Operation '400': content: @@ -3179,17 +3757,14 @@ paths: example: value: _error: - - code: INVALID_JSON_VALUE - - code: IPSECCONFIG_INVALID_ENCODED_AUTH_SECRET - - code: IPSECCONFIG_IKEGROUP_REQUIRED - - code: IPSECCONFIG_INVALID_DPD_DELAY - - code: IPSECCONFIG_ESPGROUP_REQUIRED - - code: IPSECCONFIG_AUTHENTICATION_REQUIRED - - code: IPSECCONFIG_INVALID_DPD_TIMEOUT + - code: WAN_INTERFACE_LABEL_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: WAN_INTERFACE_LABEL_MISMATCH schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update IPSEC Profile (v2.1) + summary: Update specific WAN interface label (v2.1) tags: - Network Constructs /v2.1/api/tenants/{tenant_id}/wannetworks: @@ -3416,6 +3991,177 @@ paths: summary: Update WAN Network (v2.1) tags: - Network Constructs + /v2.2/api/tenants/{tenant_id}/waninterfacelabels: + get: + description: Get WAN interface labels for a tenant + operationId: get-v2.2-api-tenants-tenant_id-waninterfacelabels + parameters: + - description: 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/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceLabelV2N2' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get WAN interface labels for a tenant (v2.2) + tags: + - Network Constructs + /v2.2/api/tenants/{tenant_id}/waninterfacelabels/query: + post: + description: Query db for site WAN interfaces that match query parameters + operationId: post-v2.2-api-tenants-tenant_id-waninterfacelabels-query + 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/WANInterfaceLabelQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceLabelQuery' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query db for site WAN interfaces that match query parameters (v2.2) + tags: + - Network Constructs + /v2.2/api/tenants/{tenant_id}/waninterfacelabels/{wantinterface_label_id}: + get: + description: Get a specific WAN interface label + operationId: get-v2.2-api-tenants-tenant_id-waninterfacelabels-wantinterface_label_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Label Id + in: path + name: wantinterface_label_id + required: true + schema: + description: Wantinterface Label Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceLabelV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get a specific WAN interface label (v2.2) + tags: + - Network Constructs + put: + description: Update specific WAN interface label + operationId: put-v2.2-api-tenants-tenant_id-waninterfacelabels-wantinterface_label_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Label Id + in: path + name: wantinterface_label_id + required: true + schema: + description: Wantinterface Label Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceLabelScreenV2N2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceLabelV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT + - code: VPNLINK_CONFIG_REQUIRED + - code: WAN_INTERFACE_LABEL_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update specific WAN interface label (v2.2) + tags: + - Network Constructs /v2.3/api/tenants/{tenant_id}/waninterfacelabels: get: description: List all the WAN interface labels for a tenant. @@ -3759,54 +4505,10 @@ paths: summary: Update WAN Interface Label (v2.4) tags: - Network Constructs - /v3.2/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 - 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/LANNetworkQuery' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/LANNetworkQueryFilterResponse' - 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 Site LAN networks that match query parameters (v3.2) - tags: - - Network Constructs - /v3.2/api/tenants/{tenant_id}/sites/{site_id}/lannetworks: + /v3.0/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.0-api-tenants-tenant_id-sites-site_id-lannetworks parameters: - description: tenant ID in: path @@ -3828,20 +4530,20 @@ paths: application/json: schema: allOf: - - $ref: '#/components/schemas/BulkResponse' + - $ref: '#/components/schemas/ListQueryResponse' - properties: items: items: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3' type: array type: object description: Successful Operation - summary: Get LAN networks (v3.2) + summary: Get LAN networks (v3.0) tags: - Network Constructs post: description: Create a new LAN - operationId: post-v3.2-api-tenants-tenant_id-sites-site_id-lannetworks + operationId: post-v3.0-api-tenants-tenant_id-sites-site_id-lannetworks parameters: - description: tenant ID in: path @@ -3861,14 +4563,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkScreenV3N2' + $ref: '#/components/schemas/LANNetworkScreenV3' description: Details of the network to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3' description: Successful Operation '400': content: @@ -3888,29 +4590,25 @@ 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.2) + summary: Create a new LAN (v3.0) tags: - Network Constructs - /v3.2/api/tenants/{tenant_id}/sites/{site_id}/lannetworks/query: + /v3.0/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 + description: Query LAN networks that match query params + operationId: post-v3.0-api-tenants-tenant_id-sites-site_id-lannetworks-query parameters: - - description: The ID of the tenant. + - description: tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the site. + - description: site ID in: path name: site_id required: true @@ -3932,33 +4630,33 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LANNetworkQueryFilterV3N2' + $ref: '#/components/schemas/LANNetworkV3' type: array type: object description: Successful Operation - summary: Query LAN Networks (v3.2) + summary: Query LAN networks that match query params (v3.0) tags: - Network Constructs - /v3.2/api/tenants/{tenant_id}/sites/{site_id}/lannetworks/{lannetwork_id}: + /v3.0/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 + description: Delete an existing LAN + operationId: delete-v3.0-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id parameters: - - description: The ID of the tenant. + - description: tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 LAN network. + - description: LAN network ID in: path name: lannetwork_id required: true @@ -3970,7 +4668,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3' description: Successful Operation '400': content: @@ -3983,28 +4681,28 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete LAN Network (v3.2) + summary: Delete an existing LAN (v3.0) tags: - Network Constructs get: - description: List a LAN network. - operationId: get-v3.2-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id + description: Get LAN network + operationId: get-v3.0-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id parameters: - - description: The ID of the tenant. + - description: tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 LAN network. + - description: LAN network ID in: path name: lannetwork_id required: true @@ -4016,30 +4714,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3' description: Successful Operation - summary: Get LAN Network (v3.2) + summary: Get LAN network (v3.0) tags: - Network Constructs put: - description: Update an existing LAN network. - operationId: put-v3.2-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id + description: Update an existing LAN + operationId: put-v3.0-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id parameters: - - description: The ID of the tenant. + - description: tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 LAN network. + - description: LAN network ID in: path name: lannetwork_id required: true @@ -4050,14 +4748,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkScreenV3N2' + $ref: '#/components/schemas/LANNetworkScreenV3' description: Details of the network to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3' description: Successful Operation '400': content: @@ -4078,20 +4776,16 @@ 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.2) + summary: Update an existing LAN (v3.0) tags: - Network Constructs - /v3.3/api/tenants/{tenant_id}/lannetworks/query: + /v3.1/api/tenants/{tenant_id}/lannetworks/query: post: description: Query db for Site LAN networks that match query parameters - operationId: post-v3.3-api-tenants-tenant_id-lannetworks-query + operationId: post-v3.1-api-tenants-tenant_id-lannetworks-query parameters: - description: Tenant Id in: path @@ -4129,13 +4823,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query db for Site LAN networks that match query parameters (v3.3) + summary: Query db for Site LAN networks that match query parameters (v3.1) tags: - Network Constructs - /v3.3/api/tenants/{tenant_id}/sites/{site_id}/lannetworks: + /v3.1/api/tenants/{tenant_id}/sites/{site_id}/lannetworks: get: description: Get LAN networks - operationId: get-v3.3-api-tenants-tenant_id-sites-site_id-lannetworks + operationId: get-v3.1-api-tenants-tenant_id-sites-site_id-lannetworks parameters: - description: tenant ID in: path @@ -4161,16 +4855,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LANNetworkV3N3' + $ref: '#/components/schemas/LANNetworkV3N1' type: array type: object description: Successful Operation - summary: Get LAN networks (v3.3) + summary: Get LAN networks (v3.1) tags: - Network Constructs post: description: Create a new LAN - operationId: post-v3.3-api-tenants-tenant_id-sites-site_id-lannetworks + operationId: post-v3.1-api-tenants-tenant_id-sites-site_id-lannetworks parameters: - description: tenant ID in: path @@ -4190,14 +4884,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkScreenV3N3' + $ref: '#/components/schemas/LANNetworkScreenV3N1' description: Details of the network to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N3' + $ref: '#/components/schemas/LANNetworkV3N1' description: Successful Operation '400': content: @@ -4217,29 +4911,25 @@ 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.3) + summary: Create a new LAN (v3.1) tags: - Network Constructs - /v3.3/api/tenants/{tenant_id}/sites/{site_id}/lannetworks/query: + /v3.1/api/tenants/{tenant_id}/sites/{site_id}/lannetworks/query: post: - description: Query LAN networks that match query parameters. - operationId: post-v3.3-api-tenants-tenant_id-sites-site_id-lannetworks-query + description: Query LAN networks that match query params + operationId: post-v3.1-api-tenants-tenant_id-sites-site_id-lannetworks-query parameters: - - description: The ID of the tenant. + - description: tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the site. + - description: site ID in: path name: site_id required: true @@ -4261,33 +4951,33 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LANNetworkQueryFilterV3N3' + $ref: '#/components/schemas/LANNetworkQueryFilterV3N1' type: array type: object description: Successful Operation - summary: Query LAN Networks (v3.3) + summary: Query LAN networks that match query params (v3.1) tags: - Network Constructs - /v3.3/api/tenants/{tenant_id}/sites/{site_id}/lannetworks/{lannetwork_id}: + /v3.1/api/tenants/{tenant_id}/sites/{site_id}/lannetworks/{lannetwork_id}: delete: - description: Delete an existing LAN network. - operationId: delete-v3.3-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id + description: Delete an existing LAN + operationId: delete-v3.1-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id parameters: - - description: The ID of the tenant. + - description: tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 LAN network. + - description: LAN network ID in: path name: lannetwork_id required: true @@ -4299,7 +4989,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N3' + $ref: '#/components/schemas/LANNetworkV3N1' description: Successful Operation '400': content: @@ -4312,28 +5002,28 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete LAN Network (v3.3) + summary: Delete an existing LAN (v3.1) tags: - Network Constructs get: - description: List a LAN network. - operationId: get-v3.3-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id + description: Get LAN network + operationId: get-v3.1-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id parameters: - - description: The ID of the tenant. + - description: tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 LAN network. + - description: LAN network ID in: path name: lannetwork_id required: true @@ -4345,30 +5035,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N3' + $ref: '#/components/schemas/LANNetworkV3N1' description: Successful Operation - summary: Get LAN Network (v3.3) + summary: Get LAN network (v3.1) tags: - Network Constructs put: - description: Update an existing LAN network. - operationId: put-v3.3-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id + description: Update an existing LAN + operationId: put-v3.1-api-tenants-tenant_id-sites-site_id-lannetworks-lannetwork_id parameters: - - description: The ID of the tenant. + - description: tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 LAN network. + - description: LAN network ID in: path name: lannetwork_id required: true @@ -4379,14 +5069,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkScreenV3N3' + $ref: '#/components/schemas/LANNetworkScreenV3N1' description: Details of the network to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N3' + $ref: '#/components/schemas/LANNetworkV3N1' description: Successful Operation '400': content: @@ -4407,14 +5097,10 @@ 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.3) + summary: Update an existing LAN (v3.1) tags: - Network Constructs servers: diff --git a/openapi-specs/sdwan/legacy/PathPolicy.yaml b/openapi-specs/sdwan/legacy/PathPolicy.yaml index 5392587d0..55191d8bb 100644 --- a/openapi-specs/sdwan/legacy/PathPolicy.yaml +++ b/openapi-specs/sdwan/legacy/PathPolicy.yaml @@ -2,21 +2,9 @@ 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: @@ -26,28 +14,6 @@ components: - 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 BasePolicyRule: properties: description: @@ -404,50 +370,6 @@ components: type: array required: - name - NetworkPolicyGlobalPrefixV2N1: - properties: - description: - description: 'The description of the network policy global prefix. Max size - = 256. - - ' - id: - description: 'The ID of the network policy global prefix. - - ' - type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the network policy global prefix. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'Lists the IPv6 addresses of the network policy global prefix. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - name: - description: 'The name of the network policy global prefix. - - ' - type: string - tags: - description: 'A information field that can be added to identify the network - policy global prefix. Maximum 10 unique tags of length 1024 each are allowed. - - ' - items: - description: Tags - type: string - type: array - required: - - name NetworkPolicyLocalPrefix: properties: description: @@ -546,80 +468,77 @@ components: required: - paths_allowed - name - NetworkPolicyRuleQueryFilterV2N1: + NetworkPolicyRuleQuery: properties: - app_def_ids: - description: 'The app definition IDs that have applied network policy rules. - The number of applications for a policy rule is limited to 256. + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of network policy rules that match the + query parameters. ' - items: - description: App Def Ids - type: string - type: array - description: - description: 'The description of the network policy rule. Max size = 256. + dest_page: + description: 'The destination page. ' - destination_prefixes_id: - description: 'The destination prefix ID. + format: int32 + type: integer + getDeleted: + description: 'The number of network policy rules deleted for a time frame. ' - type: string - enabled: - description: "The network policy rule based on rules that are enabled. \ - \ \n" type: boolean - id: - description: 'The network policy rule ID. + group_by: + description: 'Group the network policy rules for the query. ' + items: + description: Group By + type: string + type: array + id: + description: "Lists the network policy rules by ID. \n" type: string - name: - description: 'The name of the network policy rule. Max size = 128. + last_query_ts: + description: 'Return the ID of a specified query in the current session. ' - type: string - network_context_id: - description: "The network context applied to the network policy rule. Network\ - \ context segments network traffic for the purpose of applying different\ - \ network policy rules for the same application. \n" - type: string - order_number: - description: "The network policy rule order number. The default order number\ - \ for a policy rule is 1024. \n" + format: int64 type: integer - paths_allowed: - $ref: '#/components/schemas/PathsAllowedV2N1' - description: 'The paths allowed for the application. - - ' - policyset_id: - description: "The policy set ID. \n" - type: string - service_context: - $ref: '#/components/schemas/ServiceContext' - description: 'Information on the service context. + limit: + description: 'The query limit. ' - source_prefixes_id: - description: 'The ID of the source prefixes. + format: int32 + type: integer + next_query: + description: 'The limit. ' - 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. + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. ' items: - description: Tags + description: Retrieved Fields type: string type: array - required: - - paths_allowed - - name - NetworkPolicyRuleQueryFilterV2N2: + 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 + NetworkPolicyRuleQueryFilter: properties: app_def_ids: description: 'The app definition IDs that have applied network policy rules. @@ -663,7 +582,7 @@ components: \ for a policy rule is 1024. \n" type: integer paths_allowed: - $ref: '#/components/schemas/PathsAllowedV2N1' + $ref: '#/components/schemas/PathsAllowed' description: 'The paths allowed for the application. ' @@ -689,15 +608,10 @@ components: description: Tags type: string type: array - user_or_group: - $ref: '#/components/schemas/UserGroup' - description: 'The details of the user or group. - - ' required: - paths_allowed - name - NetworkPolicyRuleScreenV2N1: + NetworkPolicyRuleQueryFilterV2N1: properties: app_def_ids: description: 'The app definition IDs that have applied network policy rules. @@ -745,6 +659,9 @@ components: description: 'The paths allowed for the application. ' + policyset_id: + description: "The policy set ID. \n" + type: string service_context: $ref: '#/components/schemas/ServiceContext' description: 'Information on the service context. @@ -767,7 +684,7 @@ components: required: - paths_allowed - name - NetworkPolicyRuleScreenV2N2: + NetworkPolicyRuleScreen: properties: app_def_ids: description: 'The app definition IDs that have applied network policy rules. @@ -811,7 +728,7 @@ components: \ for a policy rule is 1024. \n" type: integer paths_allowed: - $ref: '#/components/schemas/PathsAllowedV2N1' + $ref: '#/components/schemas/PathsAllowed' description: 'The paths allowed for the application. ' @@ -834,15 +751,10 @@ components: description: Tags type: string type: array - user_or_group: - $ref: '#/components/schemas/UserGroup' - description: 'The details of the user or group. - - ' required: - paths_allowed - name - NetworkPolicyRuleV2N1: + NetworkPolicyRuleScreenV2N1: properties: app_def_ids: description: 'The app definition IDs that have applied network policy rules. @@ -909,7 +821,10 @@ components: description: Tags type: string type: array - NetworkPolicyRuleV2N2: + required: + - paths_allowed + - name + NetworkPolicyRuleV2N1: properties: app_def_ids: description: 'The app definition IDs that have applied network policy rules. @@ -976,14 +891,6 @@ components: description: Tags type: string type: array - user_or_group: - $ref: '#/components/schemas/UserGroup' - description: 'The details of the user or group. - - ' - required: - - paths_allowed - - name NetworkPolicySet: properties: clone_from: @@ -1434,41 +1341,6 @@ components: description: 'A information field that can be added to identify the site prefix. Maximum 10 unique tags of length 1024 each are allowed. - ' - items: - description: Tags - type: string - type: array - SiteNetworkPrefixAssociationV2N1: - properties: - id: - description: 'The ID of the site prefix. - - ' - type: string - ipv4_prefixes: - description: 'The individual IPv4 prefixes address. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'The individual IPv4 prefixes address. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - prefix_id: - description: "The IP Prefix ID that associates with a site. \n" - type: string - tags: - description: 'A information field that can be added to identify the site - prefix. Maximum 10 unique tags of length 1024 each are allowed. - ' items: description: Tags @@ -1576,64 +1448,6 @@ components: description: Tags type: string type: array - SitePrefixAssociationQueryFilterV2N1: - properties: - id: - description: 'The ID of the site prefix. - - ' - type: string - ipv4_prefixes: - description: 'The individual IP address. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'Lists the IPv6 address. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - prefix_id: - description: "The IP Prefix ID that associates with a site. \n" - type: string - site_id: - description: 'The site ID binding the prefix. - - ' - type: string - tags: - description: 'A information field that can be added to identify the site - prefix. Maximum 10 unique tags of length 1024 each are allowed. - - ' - items: - description: Tags - type: string - type: array - UserGroup: - properties: - user_group_ids: - description: 'The user group IDs. - - ' - items: - description: User Group Ids - type: string - type: array - user_ids: - description: 'The user IDs. - - ' - items: - description: User Ids - type: string - type: array WANPath: properties: label: @@ -2120,9 +1934,54 @@ paths: summary: Update Network Policy Local Prefix (v2.0) tags: - Path Policy - /v2.0/api/tenants/{tenant_id}/networkpolicysets: - get: - description: List all the network policy sets of a tenant. + /v2.0/api/tenants/{tenant_id}/networkpolicyrules/query: + post: + description: Query Network policy rules. + operationId: post-v2.0-api-tenants-tenant_id-networkpolicyrules-query + 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/NetworkPolicyRuleQuery' + description: Details to query the Network policy rules. + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/NetworkPolicyRuleQueryFilter' + 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 Network policy rules. (v2.0) + tags: + - Path Policy + /v2.0/api/tenants/{tenant_id}/networkpolicysets: + get: + description: List all the network policy sets of a tenant. operationId: get-v2.0-api-tenants-tenant_id-networkpolicysets parameters: - description: The tenant ID. @@ -2352,47 +2211,25 @@ paths: summary: Update Network Policy Set (v2.0) tags: - Path Policy - /v2.0/api/tenants/{tenant_id}/networkpolicysets/{policy_set_id}/status: + /v2.0/api/tenants/{tenant_id}/networkpolicysets/{policy_set_id}/networkpolicyrules: get: - description: List a specific network policy set status of tenant. - operationId: get-v2.0-api-tenants-tenant_id-networkpolicysets-policy_set_id-status + description: Get network policy rules of tenant + operationId: get-v2.0-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The network policy set ID. + - description: NetworkPolicySet Id in: path name: policy_set_id required: true schema: description: Policy Set Id type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicySetState' - description: Successful Operation - summary: Get Network Policy Set Status (v2.0) - tags: - - Path Policy - /v2.0/api/tenants/{tenant_id}/networkpolicysetstacks: - get: - description: List all the network policy set stacks of a tenant. - operationId: get-v2.0-api-tenants-tenant_id-networkpolicysetstacks - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string responses: '200': content: @@ -2403,89 +2240,43 @@ paths: - properties: items: items: - $ref: '#/components/schemas/NetworkPolicySetStack' + $ref: '#/components/schemas/NetworkPolicyRule' type: array type: object description: Successful Operation - summary: Get Network Policy Set Stacks (v2.0) + summary: Get network policy rules of tenant (v2.0) tags: - Path Policy post: - description: Create a network policy set stack. - operationId: post-v2.0-api-tenants-tenant_id-networkpolicysetstacks + description: Create a new NetworkPolicyRule + operationId: post-v2.0-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicySetStack' - description: Details of the network policy stack to be created - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicySetStack' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_DEFAULTRULE_POLICYSET_ID - - code: POLICYSETSTACK_CONFIG_DUPLICATE_POLICYSETID - - code: POLICYSETSTACK_CONFIG_INVALID_POLICYSET_IDS - - code: POLICYSETSTACK_CONFIG_INVALID_POLICYSET_STATE - - code: POLICYSETSTACK_CONFIG_INVALID_DEFAULTRULE_POLICYSET_STATE - - code: DEFAULT_POLICYSET_STACK_EXISTS - - code: POLICYSETSTACK_CONFIG_DEFAULTRULE_POLICYSET_REQUIRED - - code: INVALID_DEFAULTRULE_POLICYSET_ID_FORMAT - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Network Policy Set Stack (v2.0) - tags: - - Path Policy - /v2.0/api/tenants/{tenant_id}/networkpolicysetstacks/query: - post: - description: Query all the network policy set stacks. - operationId: post-v2.0-api-tenants-tenant_id-networkpolicysetstacks-query - parameters: - - description: The tenant ID. + - description: NetworkPolicySet ID 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/PolicySetStackQuery' - description: Details to query the Network policy Global prefix. + $ref: '#/components/schemas/NetworkPolicyRule' + description: Details of the network policy to be created responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/NetworkPolicySetStackQueryFilter' - type: array - type: object + $ref: '#/components/schemas/NetworkPolicyRule' description: Successful Operation '400': content: @@ -2493,38 +2284,69 @@ paths: example: value: _error: - - code: BAD_REQUEST + - code: DUPLICATE_APP_DEF_IDS + - code: APP_DEF_ID_LIST_SIZE_EXCEEDED + - code: INVALID_NETWORK_CONTEXT_ID + - code: INVALID_ORDER_NUMBER_MINIMUM_VAL + - code: INVALID_ORDER_NUMBER_MAXIMUM_VAL + - code: INVALID_SOURCE_PREFIXES_ID + - code: INVALID_DESTINATION_PREFIXES_ID + - code: PATHS_ALLOWED_REQUIRED + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: NETWORKPOLICYSET_NOT_PRESENT + - code: POLICYRULE_CREATION_NOT_ALLOWED + - code: INVALID_POLICYSET_STATE + - code: INVALID_DEFAULT_RULE_FLAG + - code: POLICYRULE_CONFIG_DEFAULT_RULE_NAME + - code: POLICYRULE_CONFIG_INVALID_APPDEF_IDS + - code: POLICYRULE_CONFIG_INVALID_NETWORK_CONTEXT + - code: POLICYRULE_CONFIG_INVALID_SOURCE_PREFIX + - code: POLICYRULE_CONFIG_INVALID_DESTINATION_PREFIX + - code: POLICYRULE_CONFIG_ACTIVE_BACKUP_SERVICELABELS_SAME + - code: POLICYRULE_CONFIG_SERVICELABEL_DOES_NOT_EXIST + - code: POLICYRULE_CONFIG_INVALID_SERVICE_LABEL_ALLOWED_TRANSIT + - code: POLICYRULE_CONFIG_INVALID_SERVICE_LABEL_REQUIRED_TRANSIT + - code: POLICYRULE_CONFIG_INVALID_CGTRANSIT_VPNPATH_MISSING + - code: POLICYRULE_CONFIG_DUPLICATE_PATHS_SPECIFIED + - code: POLICYRULE_CONFIG_ALREADY_EXISTS_FOR_THE_APPS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Network Policy Set Stacks (v2.0) + summary: Create a new NetworkPolicyRule (v2.0) tags: - Path Policy - /v2.0/api/tenants/{tenant_id}/networkpolicysetstacks/{policy_set_id}: + /v2.0/api/tenants/{tenant_id}/networkpolicysets/{policy_set_id}/networkpolicyrules/{policy_rule_id}: delete: - description: Delete a network policy set stack. - operationId: delete-v2.0-api-tenants-tenant_id-networkpolicysetstacks-policy_set_id + description: Delete network policy rule of tenant. + operationId: delete-v2.0-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The network policy set stack ID. + - description: NetworkPolicySet Id in: path name: policy_set_id required: true schema: description: Policy Set Id type: string + - description: NetworkPolicy rule Id + in: path + name: policy_rule_id + required: true + schema: + description: Policy Rule Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicySetStack' + $ref: '#/components/schemas/NetworkPolicyRuleQuery' description: Successful Operation '400': content: @@ -2532,84 +2354,86 @@ paths: example: value: _error: - - code: POLICYSETSTACK_IN_USE - - code: POLICYSETSTACK_CONFIG_DEFAULTRULE_POLICYSET_REQUIRED - - code: INVALID_DEFAULTRULE_POLICYSET_ID_FORMAT + - code: POLICY_SET_CLONE_IN_PROGRESS + - code: CANNOT_DELETE_DEFAULT_POLICY_RULE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Network Policy Set Stack (v2.0) + summary: Delete network policy rule of tenant. (v2.0) tags: - Path Policy get: - description: List a specific network policy set stack of a tenant. - operationId: get-v2.0-api-tenants-tenant_id-networkpolicysetstacks-policy_set_id + description: Get a specific network policy rule of tenant + operationId: get-v2.0-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The network policy set stack ID. + - description: Network Policy Set Id in: path name: policy_set_id required: true schema: description: Policy Set Id type: string + - description: Network Policy Rule Id + in: path + name: policy_rule_id + required: true + schema: + description: Policy Rule Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicySetStack' + $ref: '#/components/schemas/NetworkPolicyRule' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: POLICYSETSTACK_CONFIG_DEFAULTRULE_POLICYSET_REQUIRED - - code: INVALID_DEFAULTRULE_POLICYSET_ID_FORMAT - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Network Policy Set Stack (v2.0) + summary: Get a specific network policy rule of tenant (v2.0) tags: - Path Policy put: - description: Update a network policy set stack. - operationId: put-v2.0-api-tenants-tenant_id-networkpolicysetstacks-policy_set_id + description: Update network policy rule of tenant. + operationId: put-v2.0-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The network policy set stack ID. + - description: PolicySet Id in: path name: policy_set_id required: true schema: description: Policy Set Id type: string + - description: Policy rule Id + in: path + name: policy_rule_id + required: true + schema: + description: Policy Rule Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicySetStack' - description: Delete the Network policy id. + $ref: '#/components/schemas/NetworkPolicyRuleScreen' + description: Details to update the network policy rule. responses: '200': content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicySetStack' + $ref: '#/components/schemas/NetworkPolicyRule' description: Successful Operation '400': content: @@ -2617,25 +2441,47 @@ paths: example: value: _error: + - code: DUPLICATE_APP_DEF_IDS + - code: APP_DEF_ID_LIST_SIZE_EXCEEDED + - code: INVALID_NETWORK_CONTEXT_ID + - code: INVALID_ORDER_NUMBER_MINIMUM_VAL + - code: INVALID_ORDER_NUMBER_MAXIMUM_VAL + - code: INVALID_SOURCE_PREFIXES_ID + - code: INVALID_DESTINATION_PREFIXES_ID + - code: PATHS_ALLOWED_REQUIRED - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: INVALID_DEFAULTRULE_POLICYSET_ID - - code: POLICYSETSTACK_CONFIG_DUPLICATE_POLICYSETID - - code: POLICYSETSTACK_CONFIG_INVALID_POLICYSET_IDS - - code: POLICYSETSTACK_CONFIG_INVALID_DEFAULTRULE_POLICYSET_STATE - - code: DEFAULT_POLICYSET_STACK_EXISTS - - code: POLICYSETSTACK_CONFIG_DEFAULTRULE_POLICYSET_REQUIRED - - code: INVALID_DEFAULTRULE_POLICYSET_ID_FORMAT + - code: NETWORKPOLICYSET_NOT_PRESENT + - code: INVALID_POLICYSET_STATE + - code: INVALID_DEFAULT_RULE_FLAG + - code: INVALID_DEFAULT_RULE_NAME + - code: INVALID_DEFAULT_RULE_APPDEFS_UPDATE + - code: INVALID_DEFAULT_RULE_DESTINATION_PREFIX_UPDATE + - code: INVALID_DEFAULT_RULE_SOURCE_PREFIX_UPDATE + - code: INVALID_DEFAULT_RULE_ENABLED_FLAG_UPDATE + - code: INVALID_DEFAULT_RULE_NETWORK_CONTEXT_UPDATE + - code: POLICY_RULE_UPDATE_INVALID_NETWORK_CONTEXT + - code: POLICYRULE_CONFIG_INVALID_APPDEF_IDS + - code: POLICYRULE_CONFIG_INVALID_NETWORK_CONTEXT + - code: POLICYRULE_CONFIG_INVALID_SOURCE_PREFIX + - code: POLICYRULE_CONFIG_INVALID_DESTINATION_PREFIX + - code: POLICYRULE_CONFIG_ACTIVE_BACKUP_SERVICELABELS_SAME + - code: POLICYRULE_CONFIG_SERVICELABEL_DOES_NOT_EXIST + - code: POLICYRULE_CONFIG_INVALID_SERVICE_LABEL_ALLOWED_TRANSIT + - code: POLICYRULE_CONFIG_INVALID_SERVICE_LABEL_REQUIRED_TRANSIT + - code: POLICYRULE_CONFIG_INVALID_CGTRANSIT_VPNPATH_MISSING + - code: POLICYRULE_CONFIG_DUPLICATE_PATHS_SPECIFIED + - code: POLICYRULE_CONFIG_ALREADY_EXISTS_FOR_THE_APPS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Network Policy Set Stack (v2.0) + summary: Update network policy rule of tenant. (v2.0) tags: - Path Policy - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/networkpolicylocalprefixes: + /v2.0/api/tenants/{tenant_id}/networkpolicysets/{policy_set_id}/status: get: - description: List all the site network policy prefix associations. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-networkpolicylocalprefixes + description: List a specific network policy set status of tenant. + operationId: get-v2.0-api-tenants-tenant_id-networkpolicysets-policy_set_id-status parameters: - description: The tenant ID. in: path @@ -2644,235 +2490,27 @@ paths: schema: description: Tenant Id type: string - - description: The site ID. + - description: The network policy set ID. in: path - name: site_id - required: true - schema: - description: Site Id - type: string - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SiteNetworkPrefixAssociation' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Site Network Policy Prefix Associations (v2.0) - tags: - - Path Policy - post: - description: Create an association between the site and network local prefix. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-networkpolicylocalprefixes - 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/SiteNetworkPrefixAssociation' - description: Details of the site Network Policy local prefix to be associated - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SiteNetworkPrefixAssociation' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: LOCAL_PREFIX_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Association between Site and Network Local Prefix (v2.0) - tags: - - Path Policy - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/networkpolicylocalprefixes/{prefix_id}: - delete: - description: Delete an existing site network policy local prefix association. - operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-networkpolicylocalprefixes-prefix_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: ID of the network policy local prefix. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SiteNetworkPrefixAssociation' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Site Network Policy Local Prefix Association (v2.0) - tags: - - Path Policy - get: - description: List an existing site network policy local prefix association. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-networkpolicylocalprefixes-prefix_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: ID of the network policy local prefix. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SiteNetworkPrefixAssociation' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Site Network Policy Local Prefix Association (v2.0) - tags: - - Path Policy - put: - description: Update a site network policy local prefix association. - operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-networkpolicylocalprefixes-prefix_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: ID of the network policy local prefix. - in: path - name: prefix_id + name: policy_set_id required: true schema: - description: Prefix Id + description: Policy Set Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SiteNetworkPrefixAssociation' - description: Details of the site Network policy local prefix to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteNetworkPrefixAssociation' + $ref: '#/components/schemas/NetworkPolicySetState' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: LOCAL_PREFIX_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Site Network Policy Local Prefix Association (v2.0) + summary: Get Network Policy Set Status (v2.0) tags: - Path Policy - /v2.1/api/tenants/{tenant_id}/networkpolicyglobalprefixes: + /v2.0/api/tenants/{tenant_id}/networkpolicysetstacks: get: - description: List all the network policy global prefixes. - operationId: get-v2.1-api-tenants-tenant_id-networkpolicyglobalprefixes + description: List all the network policy set stacks of a tenant. + operationId: get-v2.0-api-tenants-tenant_id-networkpolicysetstacks parameters: - description: The tenant ID. in: path @@ -2891,170 +2529,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/NetworkPolicyGlobalPrefixV2N1' + $ref: '#/components/schemas/NetworkPolicySetStack' type: array type: object description: Successful Operation - summary: Get Network Policy Global Prefixes (v2.1) - tags: - - Path Policy - post: - description: Create a new global prefix. - operationId: post-v2.1-api-tenants-tenant_id-networkpolicyglobalprefixes - 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/NetworkPolicyGlobalPrefixV2N1' - description: Details of the Network Global prefix to be created - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyGlobalPrefixV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: NAME_REQD - - code: INVALID_PREFIX - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Global Prefix (v2.1) + summary: Get Network Policy Set Stacks (v2.0) tags: - Path Policy - /v2.1/api/tenants/{tenant_id}/networkpolicyglobalprefixes/query: post: - description: Query all the network global prefixes. - operationId: post-v2.1-api-tenants-tenant_id-networkpolicyglobalprefixes-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/GlobalPrefixQuery' - description: Details to query the Network policy Global prefix. - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/GlobalPrefixQueryFilter' - 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 Network Global Prefixes (v2.1) - tags: - - Path Policy - /v2.1/api/tenants/{tenant_id}/networkpolicyglobalprefixes/{prefix_id}: - delete: - description: Delete a network policy global prefix. - operationId: delete-v2.1-api-tenants-tenant_id-networkpolicyglobalprefixes-prefix_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The network global prefix ID. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyGlobalPrefixV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: PREFIX_IS_USED_IN_POLICY - - code: ENTERPRISE_PREFIX_INVALID_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Network Policy Global Prefix (v2.1) - tags: - - Path Policy - get: - description: Get a specific network policy global prefix. - operationId: get-v2.1-api-tenants-tenant_id-networkpolicyglobalprefixes-prefix_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The network global prefix ID. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyGlobalPrefixV2N1' - description: Successful Operation - summary: Get Network Policy Global Prefix (v2.1) - tags: - - Path Policy - put: - description: Update a network policy global prefix. - operationId: put-v2.1-api-tenants-tenant_id-networkpolicyglobalprefixes-prefix_id + description: Create a network policy set stack. + operationId: post-v2.0-api-tenants-tenant_id-networkpolicysetstacks parameters: - description: The tenant ID. in: path @@ -3063,25 +2547,18 @@ paths: schema: description: Tenant Id type: string - - description: The network global prefix ID. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicyGlobalPrefixV2N1' - description: Details to update the Network policy Global prefix. + $ref: '#/components/schemas/NetworkPolicySetStack' + description: Details of the network policy stack to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicyGlobalPrefixV2N1' + $ref: '#/components/schemas/NetworkPolicySetStack' description: Successful Operation '400': content: @@ -3089,68 +2566,25 @@ paths: example: value: _error: - - code: NAME_REQD - - code: INVALID_PREFIX - - code: DESCRIPTION_EXCEEDS_LIMIT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: ENTERPRISE_PREFIX_INVALID_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Network Policy Global Prefix (v2.1) - tags: - - Path Policy - /v2.1/api/tenants/{tenant_id}/networkpolicylocalprefixes/query: - post: - description: Query the site network prefix associations. - operationId: post-v2.1-api-tenants-tenant_id-networkpolicylocalprefixes-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/SitePrefixAssociationQuery' - description: Query details for site network prefix association - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SitePrefixAssociationQueryFilterV2N1' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_REQUEST + - code: INVALID_DEFAULTRULE_POLICYSET_ID + - code: POLICYSETSTACK_CONFIG_DUPLICATE_POLICYSETID + - code: POLICYSETSTACK_CONFIG_INVALID_POLICYSET_IDS + - code: POLICYSETSTACK_CONFIG_INVALID_POLICYSET_STATE + - code: POLICYSETSTACK_CONFIG_INVALID_DEFAULTRULE_POLICYSET_STATE + - code: DEFAULT_POLICYSET_STACK_EXISTS + - code: POLICYSETSTACK_CONFIG_DEFAULTRULE_POLICYSET_REQUIRED + - code: INVALID_DEFAULTRULE_POLICYSET_ID_FORMAT schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Site Network Prefix Association (v2.1) + summary: Create Network Policy Set Stack (v2.0) tags: - Path Policy - /v2.1/api/tenants/{tenant_id}/networkpolicyrules/query: + /v2.0/api/tenants/{tenant_id}/networkpolicysetstacks/query: post: - description: Query all the network policy rules. - operationId: post-v2.1-api-tenants-tenant_id-networkpolicyrules-query + description: Query all the network policy set stacks. + operationId: post-v2.0-api-tenants-tenant_id-networkpolicysetstacks-query parameters: - description: The tenant ID. in: path @@ -3163,8 +2597,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicyRuleQueryFilterV2N1' - description: Details to query the Network policy rules. + $ref: '#/components/schemas/PolicySetStackQuery' + description: Details to query the Network policy Global prefix. responses: '200': content: @@ -3175,7 +2609,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/NetworkPolicyRuleQueryFilterV2N1' + $ref: '#/components/schemas/NetworkPolicySetStackQueryFilter' type: array type: object description: Successful Operation @@ -3189,43 +2623,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Network Policy Rules (v2.1) - tags: - - Path Policy - /v2.1/api/tenants/{tenant_id}/networkpolicysets/{policy_set_id}/networkpolicyrules: - get: - description: List all the network policy rules of a tenant. - operationId: get-v2.1-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The network policy set ID. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - responses: - '200': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/NetworkPolicyRuleV2N1' - type: array - description: Successful Operation - summary: Get Network Policy Rules (v2.1) + summary: Query Network Policy Set Stacks (v2.0) tags: - Path Policy - post: - description: Create a new network policy rule. - operationId: post-v2.1-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules + /v2.0/api/tenants/{tenant_id}/networkpolicysetstacks/{policy_set_id}: + delete: + description: Delete a network policy set stack. + operationId: delete-v2.0-api-tenants-tenant_id-networkpolicysetstacks-policy_set_id parameters: - description: The tenant ID. in: path @@ -3234,25 +2638,19 @@ paths: schema: description: Tenant Id type: string - - description: The network policy set ID. + - description: The network policy set stack ID. in: path name: policy_set_id required: true schema: description: Policy Set Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyRule' - description: Details of the network policy to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicyRuleV2N1' + $ref: '#/components/schemas/NetworkPolicySetStack' description: Successful Operation '400': content: @@ -3260,41 +2658,18 @@ paths: example: value: _error: - - code: DUPLICATE_APP_DEF_IDS - - code: APP_DEF_ID_LIST_SIZE_EXCEEDED - - code: INVALID_NETWORK_CONTEXT_ID - - code: INVALID_ORDER_NUMBER_MINIMUM_VAL - - code: INVALID_ORDER_NUMBER_MAXIMUM_VAL - - code: INVALID_SOURCE_PREFIXES_ID - - code: INVALID_DESTINATION_PREFIXES_ID - - code: PATHS_ALLOWED_REQUIRED - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: NETWORKPOLICYSET_NOT_PRESENT - - code: POLICYRULE_CREATION_NOT_ALLOWED - - code: INVALID_POLICYSET_STATE - - code: INVALID_DEFAULT_RULE_FLAG - - code: POLICYRULE_CONFIG_DEFAULT_RULE_NAME - - code: POLICYRULE_CONFIG_INVALID_APPDEF_IDS - - code: POLICYRULE_CONFIG_INVALID_NETWORK_CONTEXT - - code: POLICYRULE_CONFIG_INVALID_SOURCE_PREFIX - - code: POLICYRULE_CONFIG_INVALID_DESTINATION_PREFIX - - code: POLICYRULE_CONFIG_ACTIVE_BACKUP_SERVICELABELS_SAME - - code: POLICYRULE_CONFIG_SERVICELABEL_DOES_NOT_EXIST - - code: POLICYRULE_CONFIG_INVALID_SERVICE_LABEL_ALLOWED_TRANSIT - - code: POLICYRULE_CONFIG_INVALID_SERVICE_LABEL_REQUIRED_TRANSIT - - code: POLICYRULE_CONFIG_INVALID_CGTRANSIT_VPNPATH_MISSING - - code: POLICYRULE_CONFIG_DUPLICATE_PATHS_SPECIFIED - - code: POLICYRULE_CONFIG_ALREADY_EXISTS_FOR_THE_APPS + - code: POLICYSETSTACK_IN_USE + - code: POLICYSETSTACK_CONFIG_DEFAULTRULE_POLICYSET_REQUIRED + - code: INVALID_DEFAULTRULE_POLICYSET_ID_FORMAT schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Network Policy Rule (v2.1) + summary: Delete Network Policy Set Stack (v2.0) tags: - Path Policy - /v2.1/api/tenants/{tenant_id}/networkpolicysets/{policy_set_id}/networkpolicyrules/{policy_rule_id}: - delete: - description: Delete a network policy rule of a tenant. - operationId: delete-v2.1-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id + get: + description: List a specific network policy set stack of a tenant. + operationId: get-v2.0-api-tenants-tenant_id-networkpolicysetstacks-policy_set_id parameters: - description: The tenant ID. in: path @@ -3303,26 +2678,19 @@ paths: schema: description: Tenant Id type: string - - description: The network policy set ID. + - description: The network policy set stack ID. in: path name: policy_set_id required: true schema: description: Policy Set Id type: string - - description: ID of the network policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicyRuleV2N1' + $ref: '#/components/schemas/NetworkPolicySetStack' description: Successful Operation '400': content: @@ -3330,52 +2698,17 @@ paths: example: value: _error: - - code: POLICY_SET_CLONE_IN_PROGRESS - - code: CANNOT_DELETE_DEFAULT_POLICY_RULE + - code: POLICYSETSTACK_CONFIG_DEFAULTRULE_POLICYSET_REQUIRED + - code: INVALID_DEFAULTRULE_POLICYSET_ID_FORMAT schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Network Policy Rule (v2.1) - tags: - - Path Policy - get: - description: List a specific network policy rule of a tenant. - operationId: get-v2.1-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The network policy set ID. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: ID of the network policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyRuleV2N1' - description: Successful Operation - summary: Get Network Policy Rule (v2.1) + summary: Get Network Policy Set Stack (v2.0) tags: - Path Policy put: - description: Update a network policy rule of a tenant. - operationId: put-v2.1-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id + description: Update a network policy set stack. + operationId: put-v2.0-api-tenants-tenant_id-networkpolicysetstacks-policy_set_id parameters: - description: The tenant ID. in: path @@ -3384,32 +2717,25 @@ paths: schema: description: Tenant Id type: string - - description: The network policy set ID. + - description: The network policy set stack ID. in: path name: policy_set_id required: true schema: description: Policy Set Id type: string - - description: ID of the network policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicyRuleScreenV2N1' - description: Details to update the Network Policy policy rule. + $ref: '#/components/schemas/NetworkPolicySetStack' + description: Delete the Network policy id. responses: '200': content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicyRuleV2N1' + $ref: '#/components/schemas/NetworkPolicySetStack' description: Successful Operation '400': content: @@ -3417,47 +2743,25 @@ paths: example: value: _error: - - code: DUPLICATE_APP_DEF_IDS - - code: APP_DEF_ID_LIST_SIZE_EXCEEDED - - code: INVALID_NETWORK_CONTEXT_ID - - code: INVALID_ORDER_NUMBER_MINIMUM_VAL - - code: INVALID_ORDER_NUMBER_MAXIMUM_VAL - - code: INVALID_SOURCE_PREFIXES_ID - - code: INVALID_DESTINATION_PREFIXES_ID - - code: PATHS_ALLOWED_REQUIRED - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: NETWORKPOLICYSET_NOT_PRESENT - - code: INVALID_POLICYSET_STATE - - code: INVALID_DEFAULT_RULE_FLAG - - code: INVALID_DEFAULT_RULE_NAME - - code: INVALID_DEFAULT_RULE_APPDEFS_UPDATE - - code: INVALID_DEFAULT_RULE_DESTINATION_PREFIX_UPDATE - - code: INVALID_DEFAULT_RULE_SOURCE_PREFIX_UPDATE - - code: INVALID_DEFAULT_RULE_ENABLED_FLAG_UPDATE - - code: INVALID_DEFAULT_RULE_NETWORK_CONTEXT_UPDATE - - code: POLICY_RULE_UPDATE_INVALID_NETWORK_CONTEXT - - code: POLICYRULE_CONFIG_INVALID_APPDEF_IDS - - code: POLICYRULE_CONFIG_INVALID_NETWORK_CONTEXT - - code: POLICYRULE_CONFIG_INVALID_SOURCE_PREFIX - - code: POLICYRULE_CONFIG_INVALID_DESTINATION_PREFIX - - code: POLICYRULE_CONFIG_ACTIVE_BACKUP_SERVICELABELS_SAME - - code: POLICYRULE_CONFIG_SERVICELABEL_DOES_NOT_EXIST - - code: POLICYRULE_CONFIG_INVALID_SERVICE_LABEL_ALLOWED_TRANSIT - - code: POLICYRULE_CONFIG_INVALID_SERVICE_LABEL_REQUIRED_TRANSIT - - code: POLICYRULE_CONFIG_INVALID_CGTRANSIT_VPNPATH_MISSING - - code: POLICYRULE_CONFIG_DUPLICATE_PATHS_SPECIFIED - - code: POLICYRULE_CONFIG_ALREADY_EXISTS_FOR_THE_APPS + - code: INVALID_DEFAULTRULE_POLICYSET_ID + - code: POLICYSETSTACK_CONFIG_DUPLICATE_POLICYSETID + - code: POLICYSETSTACK_CONFIG_INVALID_POLICYSET_IDS + - code: POLICYSETSTACK_CONFIG_INVALID_DEFAULTRULE_POLICYSET_STATE + - code: DEFAULT_POLICYSET_STACK_EXISTS + - code: POLICYSETSTACK_CONFIG_DEFAULTRULE_POLICYSET_REQUIRED + - code: INVALID_DEFAULTRULE_POLICYSET_ID_FORMAT schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Network Policy Rule (v2.1) + summary: Update Network Policy Set Stack (v2.0) tags: - Path Policy - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/networkpolicylocalprefixes: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/networkpolicylocalprefixes: get: description: List all the site network policy prefix associations. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-networkpolicylocalprefixes + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-networkpolicylocalprefixes parameters: - description: The tenant ID. in: path @@ -3483,7 +2787,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/SiteNetworkPrefixAssociationV2N1' + $ref: '#/components/schemas/SiteNetworkPrefixAssociation' type: array type: object description: Successful Operation @@ -3497,12 +2801,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Site Network Policy Prefix Associations (v2.1) + summary: Get Site Network Policy Prefix Associations (v2.0) tags: - Path Policy post: description: Create an association between the site and network local prefix. - operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-networkpolicylocalprefixes + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-networkpolicylocalprefixes parameters: - description: The tenant ID. in: path @@ -3522,14 +2826,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteNetworkPrefixAssociationV2N1' + $ref: '#/components/schemas/SiteNetworkPrefixAssociation' description: Details of the site Network Policy local prefix to be associated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteNetworkPrefixAssociationV2N1' + $ref: '#/components/schemas/SiteNetworkPrefixAssociation' description: Successful Operation '400': content: @@ -3543,13 +2847,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Association between Site and Network Local Prefix (v2.1) + summary: Create Association between Site and Network Local Prefix (v2.0) tags: - Path Policy - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/networkpolicylocalprefixes/{prefix_id}: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/networkpolicylocalprefixes/{prefix_id}: delete: description: Delete an existing site network policy local prefix association. - operationId: delete-v2.1-api-tenants-tenant_id-sites-site_id-networkpolicylocalprefixes-prefix_id + operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-networkpolicylocalprefixes-prefix_id parameters: - description: The tenant ID. in: path @@ -3589,12 +2893,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Site Network Policy Local Prefix Association (v2.1) + summary: Delete Site Network Policy Local Prefix Association (v2.0) tags: - Path Policy get: description: List an existing site network policy local prefix association. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-networkpolicylocalprefixes-prefix_id + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-networkpolicylocalprefixes-prefix_id parameters: - description: The tenant ID. in: path @@ -3622,7 +2926,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteNetworkPrefixAssociationV2N1' + $ref: '#/components/schemas/SiteNetworkPrefixAssociation' description: Successful Operation '400': content: @@ -3634,12 +2938,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Site Network Policy Local Prefix Association (v2.1) + summary: Get Site Network Policy Local Prefix Association (v2.0) tags: - Path Policy put: description: Update a site network policy local prefix association. - operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-networkpolicylocalprefixes-prefix_id + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-networkpolicylocalprefixes-prefix_id parameters: - description: The tenant ID. in: path @@ -3666,14 +2970,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteNetworkPrefixAssociationV2N1' + $ref: '#/components/schemas/SiteNetworkPrefixAssociation' description: Details of the site Network policy local prefix to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteNetworkPrefixAssociationV2N1' + $ref: '#/components/schemas/SiteNetworkPrefixAssociation' description: Successful Operation '400': content: @@ -3688,13 +2992,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Site Network Policy Local Prefix Association (v2.1) + summary: Update Site Network Policy Local Prefix Association (v2.0) tags: - Path Policy - /v2.2/api/tenants/{tenant_id}/networkpolicyrules/query: + /v2.1/api/tenants/{tenant_id}/networkpolicyrules/query: post: description: Query all the network policy rules. - operationId: post-v2.2-api-tenants-tenant_id-networkpolicyrules-query + operationId: post-v2.1-api-tenants-tenant_id-networkpolicyrules-query parameters: - description: The tenant ID. in: path @@ -3707,8 +3011,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicyRuleQueryFilterV2N2' - description: Details to query the Network policy rules. + $ref: '#/components/schemas/NetworkPolicyRuleQueryFilterV2N1' + description: Details to update the Network Policy local prefix. responses: '200': content: @@ -3719,7 +3023,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/NetworkPolicyRuleQueryFilterV2N2' + $ref: '#/components/schemas/NetworkPolicyRuleQueryFilterV2N1' type: array type: object description: Successful Operation @@ -3733,13 +3037,13 @@ 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.2/api/tenants/{tenant_id}/networkpolicysets/{policy_set_id}/networkpolicyrules: + /v2.1/api/tenants/{tenant_id}/networkpolicysets/{policy_set_id}/networkpolicyrules: get: description: List all the network policy rules of a tenant. - operationId: get-v2.2-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules + operationId: get-v2.1-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules parameters: - description: The tenant ID. in: path @@ -3761,15 +3065,15 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/NetworkPolicyRuleV2N2' + $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: description: Create a new network policy rule. - operationId: post-v2.2-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules + operationId: post-v2.1-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules parameters: - description: The tenant ID. in: path @@ -3789,14 +3093,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicyRuleScreenV2N2' + $ref: '#/components/schemas/NetworkPolicyRule' description: Details of the network policy to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicyRuleV2N2' + $ref: '#/components/schemas/NetworkPolicyRuleV2N1' description: Successful Operation '400': content: @@ -3832,13 +3136,13 @@ 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.2/api/tenants/{tenant_id}/networkpolicysets/{policy_set_id}/networkpolicyrules/{policy_rule_id}: + /v2.1/api/tenants/{tenant_id}/networkpolicysets/{policy_set_id}/networkpolicyrules/{policy_rule_id}: delete: description: Delete a network policy rule of a tenant. - operationId: delete-v2.2-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id + operationId: delete-v2.1-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id parameters: - description: The tenant ID. in: path @@ -3866,7 +3170,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicyRuleV2N2' + $ref: '#/components/schemas/NetworkPolicyRuleV2N1' description: Successful Operation '400': content: @@ -3879,12 +3183,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Network Policy Rule (v2.2) + summary: Delete Network Policy Rule (v2.1) tags: - Path Policy get: description: List a specific network policy rule of a tenant. - operationId: get-v2.2-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id + operationId: get-v2.1-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id parameters: - description: The tenant ID. in: path @@ -3912,14 +3216,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicyRuleV2N2' + $ref: '#/components/schemas/NetworkPolicyRuleV2N1' description: Successful Operation - summary: Get Network Policy Rule (v2.2) + summary: Get Network Policy Rule (v2.1) tags: - Path Policy put: description: Update a network policy rule of a tenant. - operationId: put-v2.2-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id + operationId: put-v2.1-api-tenants-tenant_id-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id parameters: - description: The tenant ID. in: path @@ -3935,7 +3239,7 @@ paths: schema: description: Policy Set Id type: string - - description: Policy rule Id + - description: ID of the network policy rule. in: path name: policy_rule_id required: true @@ -3946,14 +3250,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicyRuleScreenV2N2' + $ref: '#/components/schemas/NetworkPolicyRuleScreenV2N1' description: Details to update the Network Policy policy rule. responses: '200': content: application/json: schema: - $ref: '#/components/schemas/NetworkPolicyRuleV2N2' + $ref: '#/components/schemas/NetworkPolicyRuleV2N1' description: Successful Operation '400': content: @@ -3995,7 +3299,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Network Policy Rule (v2.2) + summary: Update Network Policy Rule (v2.1) tags: - Path Policy servers: diff --git a/openapi-specs/sdwan/legacy/PathPolicyOriginal.yaml b/openapi-specs/sdwan/legacy/PathPolicyOriginal.yaml index 00d5e8074..410ec4e83 100644 --- a/openapi-specs/sdwan/legacy/PathPolicyOriginal.yaml +++ b/openapi-specs/sdwan/legacy/PathPolicyOriginal.yaml @@ -2,21 +2,9 @@ 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: @@ -26,28 +14,6 @@ components: - 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 BandwidthAllocationScheme: properties: bandwidth_range: diff --git a/openapi-specs/sdwan/legacy/PrismaAccessConfigs.yaml b/openapi-specs/sdwan/legacy/PrismaAccessConfigs.yaml index e8aa6083e..311552d1e 100644 --- a/openapi-specs/sdwan/legacy/PrismaAccessConfigs.yaml +++ b/openapi-specs/sdwan/legacy/PrismaAccessConfigs.yaml @@ -117,12 +117,6 @@ components: - 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. @@ -131,12 +125,6 @@ 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. diff --git a/openapi-specs/sdwan/legacy/QOSPolicy.yaml b/openapi-specs/sdwan/legacy/QOSPolicy.yaml index e13d53dd8..36a37e1d6 100644 --- a/openapi-specs/sdwan/legacy/QOSPolicy.yaml +++ b/openapi-specs/sdwan/legacy/QOSPolicy.yaml @@ -2,21 +2,9 @@ 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: @@ -26,28 +14,6 @@ components: - 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 BandwidthAllocationSchemeV2: properties: bandwidth_range: @@ -285,48 +251,6 @@ components: type: array required: - name - GlobalPrefixQueryFilterV2N1: - properties: - description: - description: 'The description of the priority policy global prefix. - - ' - id: - description: 'The ID of the priority policy global prefix. - - ' - type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the priority policy global prefix. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'Lists the IPv6 addresses of the priority policy global prefix. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - name: - description: 'The name of the priority policy global prefix. - - ' - 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. \n" - items: - description: Tags - type: string - type: array - required: - - name ListQueryResponse: properties: count: @@ -498,49 +422,6 @@ components: type: array required: - name - PriorityPolicyGlobalPrefixV2N1: - properties: - description: - description: 'The description of the priority policy global prefix. - - ' - id: - description: 'The ID of the priority policy global prefix. - - ' - type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the priority policy global prefix. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'Lists the IPv6 addresses of the priority policy global prefix. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - name: - description: 'The name of the priority policy global prefix. - - ' - 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. - - ' - items: - description: Tags - type: string - type: array - required: - - name PriorityPolicyLocalPrefix: properties: description: @@ -792,95 +673,76 @@ components: required: - priority_number - name - PriorityPolicyRuleQueryFilterV2N1: + PriorityPolicySet: properties: - app_def_ids: - description: 'The app definition IDs that have applied priority policy rules. - The number of applications for a policy rule is limited to 256. + bandwidth_allocation_schemes: + description: 'The bandwidth allocation schemes configured for a given policy + set. Upto four bandwidth allocation schemes can be configured. ' items: - description: App Def Ids - type: string + $ref: '#/components/schemas/BandwidthAllocationSchemeV2' type: array - description: - description: 'The description of the priority policy rule. Max size = 256. + business_priority_names: + description: 'The business priority names. Max list size = 4. ' - destination_prefixes_id: - description: 'The destination prefix ID. + items: + $ref: '#/components/schemas/BusinessPriorityNameMapper' + type: array + clone_from: + description: 'The existing policy from Stacked Policies for cloning the + policy set. ' type: string - dscp: - $ref: '#/components/schemas/DSCP' - description: 'The DSCP value - When policy rules with marked DSCP bits are - applied to a site, the ION branch device will honor the bits in the first - packet on an unknown application flow, and queue the flow in the specified - priority class. + default_rule_dscp_mappings: + description: "The default rule of the DSCP mappings. \n" + items: + $ref: '#/components/schemas/DefaultRuleDSCPMapping' + type: array + defaultrule_policyset: + description: "The default rule of the policy set. \n" + type: boolean + description: + description: 'The description of the policy set. Max size = 256. ' - enabled: - description: "The priority policy rules based on rules that are enabled.\ - \ \n" - type: boolean id: - description: 'The priority policy rule ID. + description: 'The priority policy set ID. ' type: string name: - description: 'The name of the priority policy rule. Max size = 128. - - ' - type: string - network_context_id: - description: "The network context applied to the priority policy rule.\ - \ Network context segments network traffic for the purpose of applying\ - \ different QoS policy rules for the same application. \n" - type: string - order_number: - description: "The order number. The default order number for a policy rule\ - \ is 1024. \n" - type: integer - policyset_id: - description: "The policy set ID. \n" - type: string - priority_number: - description: 'The priority number. Priority determines the relative priority - of network resources assigned to each application. - - ' - format: int32 - type: integer - source_prefixes_id: - description: 'The source prefix ID. Source prefix filters are often added - as exceptions. + description: 'The name of the policy set. Max size = 128. ' 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. + 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 - user_or_group: - $ref: '#/components/schemas/UserGroup' - description: 'The details of the user or group. + template: + description: 'The template used for cloning the policy rule. The template + option creates a set of rules from a predefined template can be customized + after creation. ' + type: boolean required: - - priority_number + - business_priority_names + - bandwidth_allocation_schemes - name - PriorityPolicyRuleQueryV2N1: + PriorityPolicySetQuery: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of priority policy rules that match the + description: 'The aggregate number of priority policy sets that match the query parameters. ' @@ -891,12 +753,12 @@ components: format: int32 type: integer getDeleted: - description: 'The number of priority policy rules deleted for a time frame. + description: 'The number of priority policy sets deleted for a time frame. ' type: boolean group_by: - description: 'Group the priority policy rules for the query. + description: 'Group the priority policy sets for the query. ' items: @@ -904,7 +766,7 @@ components: type: string type: array id: - description: "Lists the priority policy rules by ID. \n" + description: "Lists the priority policy sets by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -946,267 +808,54 @@ components: ' format: int64 type: integer - PriorityPolicyRuleV2N1: + PriorityPolicySetQueryFilter: properties: - app_def_ids: - description: 'The app definition IDs that have applied priority policy rules. - The number of applications for a policy rule is limited to 256. + bandwidth_allocation_schemes: + description: 'The bandwidth allocation schemes configured for a given policy + set. Upto four bandwidth allocation schemes can be configured. ' items: - description: App Def Ids - type: string + $ref: '#/components/schemas/BandwidthAllocationSchemeV2' type: array - description: - description: 'The description of the priority policy rule. Max size = 256. + business_priority_names: + description: 'The business priority names. Max list size = 4. ' - destination_prefixes_id: - description: 'The destination prefix ID. + items: + $ref: '#/components/schemas/BusinessPriorityNameMapper' + type: array + clone_from: + description: 'The existing policy from Stacked Policies for cloning the + policy set. ' type: string - dscp: - $ref: '#/components/schemas/DSCP' - description: 'The DSCP value - When policy rules with marked DSCP bits are - applied to a site, the ION branch device will honor the bits in the first - packet on an unknown application flow, and queue the flow in the specified - priority class. + default_rule_dscp_mappings: + description: "The default rule of the DSCP mappings. \n" + items: + $ref: '#/components/schemas/DefaultRuleDSCPMapping' + type: array + defaultrule_policyset: + description: "The default rule of the policy set. \n" + type: boolean + description: + description: 'The description of the policy set. Max size = 256. ' - enabled: - description: "The priority policy rules based on rules that are enabled.\ - \ \n" - type: boolean id: - description: 'The priority policy rule ID. + description: 'The priority policy set ID. ' type: string name: - description: 'The name of the priority policy rule. Max size = 128. + description: 'The name of the policy set. Max size = 128. ' type: string - network_context_id: - description: "The network context applied to the priority policy rule.\ - \ Network context segments network traffic for the purpose of applying\ - \ different QoS policy rules for the same application. \n" - type: string - order_number: - description: "The order number. The default order number for a policy rule\ - \ is 1024. \n" - type: integer - priority_number: - description: 'The priority number. Priority determines the relative priority - of network resources assigned to each application. - - ' - format: int32 - type: integer - source_prefixes_id: - description: 'The source prefix ID. Source prefix filters are often added - as exceptions. - - ' - 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" - items: - description: Tags - type: string - type: array - user_or_group: - $ref: '#/components/schemas/UserGroup' - description: "The details of the user or group. \n" - required: - - priority_number - - name - PriorityPolicySet: - properties: - bandwidth_allocation_schemes: - description: 'The bandwidth allocation schemes configured for a given policy - set. Upto four bandwidth allocation schemes can be configured. - - ' - items: - $ref: '#/components/schemas/BandwidthAllocationSchemeV2' - type: array - business_priority_names: - description: 'The business priority names. Max list size = 4. - - ' - items: - $ref: '#/components/schemas/BusinessPriorityNameMapper' - type: array - clone_from: - description: 'The existing policy from Stacked Policies for cloning the - policy set. - - ' - type: string - default_rule_dscp_mappings: - description: "The default rule of the DSCP mappings. \n" - items: - $ref: '#/components/schemas/DefaultRuleDSCPMapping' - type: array - defaultrule_policyset: - description: "The default rule of the policy set. \n" - type: boolean - description: - description: 'The description of the policy set. Max size = 256. - - ' - id: - description: 'The priority policy set ID. - - ' - type: string - name: - description: 'The name of the policy set. Max size = 128. - - ' - type: string - 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 - template: - description: 'The template used for cloning the policy rule. The template - option creates a set of rules from a predefined template can be customized - after creation. - - ' - type: boolean - required: - - business_priority_names - - bandwidth_allocation_schemes - - name - PriorityPolicySetQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of priority policy sets that match the - query parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number of priority policy sets deleted for a time frame. - - ' - type: boolean - group_by: - description: 'Group the priority policy sets for the query. - - ' - items: - description: Group By - type: string - type: array - id: - description: "Lists the priority policy sets 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 - PriorityPolicySetQueryFilter: - properties: - bandwidth_allocation_schemes: - description: 'The bandwidth allocation schemes configured for a given policy - set. Upto four bandwidth allocation schemes can be configured. - - ' - items: - $ref: '#/components/schemas/BandwidthAllocationSchemeV2' - type: array - business_priority_names: - description: 'The business priority names. Max list size = 4. - - ' - items: - $ref: '#/components/schemas/BusinessPriorityNameMapper' - type: array - clone_from: - description: 'The existing policy from Stacked Policies for cloning the - policy set. - - ' - type: string - default_rule_dscp_mappings: - description: "The default rule of the DSCP mappings. \n" - items: - $ref: '#/components/schemas/DefaultRuleDSCPMapping' - type: array - defaultrule_policyset: - description: "The default rule of the policy set. \n" - type: boolean - description: - description: 'The description of the policy set. Max size = 256. - - ' - id: - description: 'The priority policy set ID. - - ' - type: string - name: - description: 'The name of the policy set. Max size = 128. - - ' - type: string - tags: - description: 'A information field that can be added to identify the policy - set. Maximum 10 unique tags of length 1024 each are allowed. + 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: @@ -1464,59 +1113,6 @@ components: description: Tags type: string type: array - SitePriorityPrefixAssociationV2N1: - properties: - id: - description: 'The ID of the site prefix. - - ' - type: string - ipv4_prefixes: - description: 'The individual IP address. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'Lists the IPv6 address. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - prefix_id: - description: "The IP Prefix ID that associates with a site. \n" - type: string - tags: - description: 'A information field that can be added to identify the site - prefix. Maximum 10 unique tags of length 1024 each are allowed. - - ' - items: - description: Tags - type: string - type: array - UserGroup: - properties: - user_group_ids: - description: 'The user group IDs. - - ' - items: - description: User Group Ids - type: string - type: array - user_ids: - description: 'The user IDs. - - ' - items: - description: User Ids - type: string - type: array info: contact: {} description: List of APIs used to manage the QoS policies. @@ -3055,827 +2651,6 @@ paths: summary: Update Site Priority Policy Local Prefix Association (v2.0) tags: - QOS Policy - /v2.1/api/tenants/{tenant_id}/prioritypolicyglobalprefixes: - get: - description: List all the priority policy global prefixes. - operationId: get-v2.1-api-tenants-tenant_id-prioritypolicyglobalprefixes - 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/PriorityPolicyGlobalPrefixV2N1' - type: array - type: object - description: Successful Operation - summary: Get Priority Policy GLobal Prefixes (v2.1) - tags: - - QOS Policy - post: - description: Create a new priority global prefix. - operationId: post-v2.1-api-tenants-tenant_id-prioritypolicyglobalprefixes - 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/PriorityPolicyGlobalPrefixV2N1' - description: Details of the Priority Global prefix to be created - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyGlobalPrefixV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: NAME_REQD - - code: INVALID_PREFIX - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Priority Global Prefix (v2.1) - tags: - - QOS Policy - /v2.1/api/tenants/{tenant_id}/prioritypolicyglobalprefixes/query: - post: - description: Query the priority global prefixes. - operationId: post-v2.1-api-tenants-tenant_id-prioritypolicyglobalprefixes-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/GlobalPrefixQuery' - description: Query Details for Priority Global - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/GlobalPrefixQueryFilterV2N1' - 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 Priority Global Prefixes (v2.1) - tags: - - QOS Policy - /v2.1/api/tenants/{tenant_id}/prioritypolicyglobalprefixes/{priority_policy_id}: - delete: - description: Delete a priority policy global prefix. - operationId: delete-v2.1-api-tenants-tenant_id-prioritypolicyglobalprefixes-priority_policy_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The ID of the priority policy. - in: path - name: priority_policy_id - required: true - schema: - description: Priority Policy Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyGlobalPrefixV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: PREFIX_IS_USED_IN_POLICY - - code: ENTERPRISE_PREFIX_INVALID_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Priority Policy Global Prefix (v2.1) - tags: - - QOS Policy - get: - description: List a specific priority policy global prefix. - operationId: get-v2.1-api-tenants-tenant_id-prioritypolicyglobalprefixes-priority_policy_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The ID of the priority policy. - in: path - name: priority_policy_id - required: true - schema: - description: Priority Policy Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyGlobalPrefixV2N1' - description: Successful Operation - summary: Get Priority Policy Global Prefix (v2.1) - tags: - - QOS Policy - put: - description: Update a priority policy global prefix. - operationId: put-v2.1-api-tenants-tenant_id-prioritypolicyglobalprefixes-priority_policy_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The ID of the priority policy. - in: path - name: priority_policy_id - required: true - schema: - description: Priority Policy Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyGlobalPrefixV2N1' - description: Details to update the Priority policy Global prefix. - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyGlobalPrefixV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: NAME_REQD - - code: INVALID_PREFIX - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: ENTERPRISE_PREFIX_INVALID_REQUEST - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Priority Policy Global Prefix (v2.1) - tags: - - QOS Policy - /v2.1/api/tenants/{tenant_id}/prioritypolicylocalprefixes/query: - post: - description: Query the site priority prefix association. - operationId: post-v2.1-api-tenants-tenant_id-prioritypolicylocalprefixes-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/SitePrefixAssociationQuery' - description: Query details for site priority prefix association - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SitePrefixAssociationQueryFilter' - 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 Site Priority Prefix Association (v2.1) - tags: - - QOS Policy - /v2.1/api/tenants/{tenant_id}/prioritypolicyrules/query: - post: - description: Query the priority policy rules. - operationId: post-v2.1-api-tenants-tenant_id-prioritypolicyrules-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/PriorityPolicyRuleQueryV2N1' - description: Query details for Priority Policy rules - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/PriorityPolicyRuleQueryFilterV2N1' - 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 Priority Policy Rules (v2.1) - tags: - - QOS Policy - /v2.1/api/tenants/{tenant_id}/prioritypolicysets/{policy_set_id}/prioritypolicyrules: - get: - description: List the priority policy rules of a tenant. - operationId: get-v2.1-api-tenants-tenant_id-prioritypolicysets-policy_set_id-prioritypolicyrules - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The ID of the priority 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/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/PriorityPolicyRuleV2N1' - type: array - type: object - description: Successful Operation - summary: Get Priority Policy Rules (v2.1) - tags: - - QOS Policy - post: - description: Create a new priority policy rule. - operationId: post-v2.1-api-tenants-tenant_id-prioritypolicysets-policy_set_id-prioritypolicyrules - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The ID of the priority policy set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyRuleV2N1' - description: Details of the priority policy to be created - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyRuleV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: DUPLICATE_APP_DEF_IDS - - code: APP_DEF_ID_LIST_SIZE_EXCEEDED - - code: INVALID_NETWORK_CONTEXT_ID - - code: INVALID_ORDER_NUMBER_MINIMUM_VAL - - code: INVALID_ORDER_NUMBER_MAXIMUM_VAL - - code: INVALID_SOURCE_PREFIXES_ID - - code: INVALID_DESTINATION_PREFIXES_ID - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: PRIORITYPOLICYSET_NOT_PRESENT - - code: POLICYRULE_CREATION_NOT_ALLOWED - - code: INVALID_POLICYSET_STATE - - code: INVALID_DEFAULT_RULE_FLAG - - code: POLICYRULE_CONFIG_DEFAULT_RULE_NAME - - code: POLICYRULE_CONFIG_INVALID_APPDEF_IDS - - code: POLICYRULE_CONFIG_INVALID_NETWORK_CONTEXT - - code: POLICYRULE_CONFIG_INVALID_SOURCE_PREFIX - - code: POLICYRULE_CONFIG_INVALID_DESTINATION_PREFIX - - code: POLICYRULE_CONFIG_ALREADY_EXISTS_FOR_THE_APPS - - code: INVALID_PRIORITY_NUMBER - - code: PRIORITY_NUMBER_MINIMUM_VAL - - code: PRIORITY_NUMBER_MAXIMUM_VAL - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Priority Policy Rule (v2.1) - tags: - - QOS Policy - /v2.1/api/tenants/{tenant_id}/prioritypolicysets/{policy_set_id}/prioritypolicyrules/{policy_rule_id}: - delete: - description: Delete a priority policy rule of a tenant. - operationId: delete-v2.1-api-tenants-tenant_id-prioritypolicysets-policy_set_id-prioritypolicyrules-policy_rule_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The ID of the priority policy set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: The ID of the priority policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyRuleV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: POLICY_SET_CLONE_IN_PROGRESS - - code: CANNOT_DELETE_DEFAULT_POLICY_RULE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Priority Policy Rule (v2.1) - tags: - - QOS Policy - get: - description: Get a specific priority policy rule of a tenant. - operationId: get-v2.1-api-tenants-tenant_id-prioritypolicysets-policy_set_id-prioritypolicyrules-policy_rule_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The ID of the priority policy set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: The ID of the priority policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyRuleV2N1' - description: Successful Operation - summary: Get Priority Policy Rule (v2.1) - tags: - - QOS Policy - put: - description: Update a priority policy rule of a tenant. - operationId: put-v2.1-api-tenants-tenant_id-prioritypolicysets-policy_set_id-prioritypolicyrules-policy_rule_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The ID of the priority policy set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: The ID of the priority policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyRuleV2N1' - description: Query details for Priority Policy rules - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyRuleV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: DUPLICATE_APP_DEF_IDS - - code: APP_DEF_ID_LIST_SIZE_EXCEEDED - - code: INVALID_NETWORK_CONTEXT_ID - - code: INVALID_ORDER_NUMBER_MINIMUM_VAL - - code: INVALID_ORDER_NUMBER_MAXIMUM_VAL - - code: INVALID_SOURCE_PREFIXES_ID - - code: INVALID_DESTINATION_PREFIXES_ID - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: PRIORITYPOLICYSET_NOT_PRESENT - - code: INVALID_POLICYSET_STATE - - code: INVALID_DEFAULT_RULE_FLAG - - code: INVALID_DEFAULT_RULE_NAME - - code: INVALID_DEFAULT_RULE_APPDEFS_UPDATE - - code: INVALID_DEFAULT_RULE_DESTINATION_PREFIX_UPDATE - - code: INVALID_DEFAULT_RULE_SOURCE_PREFIX_UPDATE - - code: INVALID_DEFAULT_RULE_ENABLED_FLAG_UPDATE - - code: INVALID_DEFAULT_RULE_NETWORK_CONTEXT_UPDATE - - code: POLICY_RULE_UPDATE_INVALID_NETWORK_CONTEXT - - code: POLICYRULE_CONFIG_INVALID_APPDEF_IDS - - code: POLICYRULE_CONFIG_INVALID_NETWORK_CONTEXT - - code: POLICYRULE_CONFIG_INVALID_SOURCE_PREFIX - - code: POLICYRULE_CONFIG_INVALID_DESTINATION_PREFIX - - code: POLICYRULE_CONFIG_ALREADY_EXISTS_FOR_THE_APPS - - code: INVALID_PRIORITY_NUMBER - - code: PRIORITY_NUMBER_MINIMUM_VAL - - code: PRIORITY_NUMBER_MAXIMUM_VAL - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Priority Policy Rule (v2.1) - tags: - - QOS Policy - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/prioritypolicylocalprefixes: - get: - description: List all the site priority policy prefix associations. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-prioritypolicylocalprefixes - parameters: - - 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 - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SitePriorityPrefixAssociationV2N1' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Site Priority Policy Prefix Associations (v2.1) - tags: - - QOS Policy - post: - description: Create an association between the site and the priority local prefix. - operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-prioritypolicylocalprefixes - parameters: - - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SitePriorityPrefixAssociationV2N1' - description: Details of the site Priority Policy local prefix to be associated - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SitePriorityPrefixAssociationV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: NETWRK_POLICY_PREFIX_INVALID - - code: LOCAL_PREFIX_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Association between Site and Priority Local Prefix (v2.1) - tags: - - QOS Policy - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/prioritypolicylocalprefixes/{prefix_id}: - delete: - description: Delete an existing site priority policy local prefix association. - operationId: delete-v2.1-api-tenants-tenant_id-sites-site_id-prioritypolicylocalprefixes-prefix_id - parameters: - - 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 priority policy local prefix ID. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SitePriorityPrefixAssociationV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Site Priority Policy Local Prefix Association (v2.1) - tags: - - QOS Policy - get: - description: List a site priority policy local prefix association. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-prioritypolicylocalprefixes-prefix_id - parameters: - - 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 priority policy local prefix ID. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SitePriorityPrefixAssociationV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Site Priority Policy Local Prefix Association (v2.1) - tags: - - QOS Policy - put: - description: Update an existing site priority policy local prefix association. - operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-prioritypolicylocalprefixes-prefix_id - parameters: - - 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 priority policy local prefix ID. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SitePriorityPrefixAssociationV2N1' - description: Details of the site Priority policy local prefix to be updated - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SitePriorityPrefixAssociationV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: PRIORITY_POLICY_PREFIX_INVALID - - code: LOCAL_PREFIX_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Site Priority Policy Local Prefix Association (v2.1) - tags: - - QOS Policy servers: - url: https://api.us.cloudgenix.com tags: diff --git a/openapi-specs/sdwan/legacy/Routing.yaml b/openapi-specs/sdwan/legacy/Routing.yaml index e98038765..f12db0d6e 100644 --- a/openapi-specs/sdwan/legacy/Routing.yaml +++ b/openapi-specs/sdwan/legacy/Routing.yaml @@ -24,21 +24,9 @@ components: properties: {} 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: @@ -48,28 +36,6 @@ components: - 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 BGPConfig: properties: adv_interval: @@ -121,7 +87,7 @@ components: \ default is 120 seconds. \n" format: int32 type: integer - BGPGlobalConfigScreenV2N2: + BGPGlobalConfig: properties: admin_distance: description: "The BGP config admin distance. The device sets the default\ @@ -189,12 +155,6 @@ 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. @@ -206,11 +166,6 @@ components: description: 'The type of prefix advertisement; Default, Unaggregated or Auto-aggregated. - ' - type: string - prefix_adv_type_to_lan: - description: 'The prefix advertises to LAN. - ' type: string prefixes_to_adv_to_wan: @@ -233,7 +188,7 @@ components: ' format: int32 type: integer - BGPGlobalConfigScreenV2N3: + BGPGlobalConfigScreen: properties: admin_distance: description: "The BGP config admin distance. The device sets the default\ @@ -264,14 +219,6 @@ 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. @@ -309,14 +256,6 @@ 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. @@ -328,11 +267,6 @@ components: description: 'The type of prefix advertisement; Default, Unaggregated or Auto-aggregated. - ' - type: string - prefix_adv_type_to_lan: - description: 'The prefix advertises to LAN. - ' type: string prefixes_to_adv_to_wan: @@ -355,7 +289,7 @@ components: ' format: int32 type: integer - BGPGlobalConfigV2N2: + BGPGlobalConfigScreenV2N1: properties: admin_distance: description: "The BGP config admin distance. The device sets the default\ @@ -423,14 +357,6 @@ 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. @@ -445,9 +371,7 @@ components: ' type: string prefix_adv_type_to_lan: - description: 'The prefix advertises to LAN. - - ' + description: Prefix Adv Type To Lan type: string prefixes_to_adv_to_wan: description: 'The prefix advertises to WAN. @@ -469,7 +393,7 @@ components: ' format: int32 type: integer - BGPGlobalConfigV2N3: + BGPGlobalConfigScreenV2N2: properties: admin_distance: description: "The BGP config admin distance. The device sets the default\ @@ -500,14 +424,6 @@ 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. @@ -546,7 +462,7 @@ 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. \n" enum: - md5 - none @@ -589,230 +505,310 @@ components: ' format: int32 type: integer - BGPPeerAdvertisedPrefixes: + BGPGlobalConfigV2N1: properties: - advertised_prefix_count: - description: 'The advertised prefix count for the BGP peer. + admin_distance: + description: "The BGP config admin distance. The device sets the default\ + \ Admin Distance of all learned prefixes to 20. The admin value should\ + \ be in the range 1-255. \n" + format: int32 + type: integer + adv_interval: + description: 'The advertisement interval of the BGP config. The advertisement + interval should be between 0 - 300 seconds and the default is 1 second. ' format: int32 type: integer - advertised_prefixes: - $ref: '#/components/schemas/PrefixSet' - description: 'The advertised prefixes of the BGP peer. + graceful_restart: + description: 'By default, graceful restart is Off. Change the default setting + to On. ' - id: - description: 'The ID of the BGP peer. + type: boolean + hold_time: + description: 'The BGP config hold time. The hold time should be between + 3 - 600 seconds. ' - type: string - BGPPeerAdvertisedPrefixesV2N1: - properties: - 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" + description: "The BGP configuration ID. \n" type: string - BGPPeerConfigScreenV2N3: - properties: - bgp_config: - $ref: '#/components/schemas/BGPConfig' - description: 'The details of the BGP config. + keepalive_time: + description: 'The keep-alive time of the BGP config. The keep-alive time + should be between 3 - 200 seconds. ' - description: - description: "The description of the BGP peer config. Max size = 1024. \n" - id: - description: 'The ID of the BGP peer config. + format: int32 + type: integer + local_as_num: + description: 'The Local AS Number should be between 1 and 4294967295 or + as A.B, where A and B are both numbers between 1 and 4294967295. If the + number entered is an A.B format, the web interface displays the corresponding + 32-bit conversion below the entered value. If the number entered is a + 32-bit format, the web interface displays the corresponding A.B value + below the entered value. The Local AS Number is mandatory. ' type: string - name: - description: 'The name of the BGP peer config. Max size = 128. + maximum_paths: + description: 'The BGP config maximum paths. The max path value should be + between 1 - 255. The default is 1. ' - 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. + format: int32 + type: integer + md5_secret: + description: 'The MD5 Secret should be between 1 and 32 characters. The + default value is 0. ' type: string - remote_as_num: - description: 'The remote AS number. + multi_hop_limit: + description: 'The BGP config multi hop limit. The multi-hop limit should + be between 1 - 255 hops. The default is 1 hop. ' - type: string - route_map_in_id: - description: 'The ID of the Route Map In to filter incoming routes. + format: int32 + type: integer + peer_retry_time: + description: 'The peer retry time should be between 0 - 65535 seconds. The + default is 120 seconds. ' - type: string - route_map_out_id: - description: 'The ID of the Route Map Out to filter outgoing routes. + format: int32 + type: integer + prefix_adv_type: + description: 'The type of prefix advertisement; Default, Unaggregated or + Auto-aggregated. ' 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. - - ' - enum: - - GLOBAL - - LOCAL + prefix_adv_type_to_lan: + description: Prefix Adv Type To Lan 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. + prefixes_to_adv_to_wan: + description: 'The prefix advertises to WAN. ' items: - description: Tags + description: Prefixes To Adv To Wan type: string type: array - update_source: - description: 'The Update Source IP address. + router_id: + description: 'The IP address of the ION device. Max size = 256. ' type: string - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. + stalepath_time: + description: 'The stale path time for the BGP config. The stalepath time + should be between 1 - 3600 seconds. The default is 120 seconds. ' - type: string - required: - - remote_as_num - - name - BGPPeerConfigScreenV2N4: + format: int32 + type: integer + BGPGlobalConfigV2N2: properties: - allow_v4_prefixes: - description: 'Allow v4 prefixes. + admin_distance: + description: "The BGP config admin distance. The device sets the default\ + \ Admin Distance of all learned prefixes to 20. The admin value should\ + \ be in the range 1-255. \n" + format: int32 + type: integer + adv_interval: + description: 'The advertisement interval of the BGP config. The advertisement + interval should be between 0 - 300 seconds and the default is 1 second. ' - 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. + format: int32 + type: integer + graceful_restart: + description: 'By default, graceful restart is Off. Change the default setting + to On. ' - description: - description: "The description of the BGP peer config. Max size = 1024. \n" - id: - description: 'The ID of the BGP peer config. + type: boolean + hold_time: + description: 'The BGP config hold time. The hold time should be between + 3 - 600 seconds. ' + format: int32 + type: integer + id: + description: "The BGP configuration ID. \n" type: string - name: - description: 'The name of the BGP peer config. Max size = 128. + keepalive_time: + description: 'The keep-alive time of the BGP config. The keep-alive time + should be between 3 - 200 seconds. ' - type: string - peer_ip: - description: 'The peer IP address. + format: int32 + type: integer + local_as_num: + description: 'The Local AS Number should be between 1 and 4294967295 or + as A.B, where A and B are both numbers between 1 and 4294967295. If the + number entered is an A.B format, the web interface displays the corresponding + 32-bit conversion below the entered value. If the number entered is a + 32-bit format, the web interface displays the corresponding A.B value + below the entered value. The Local AS Number is mandatory. ' 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 - only for data center ION devices. + maximum_paths: + description: 'The BGP config maximum paths. The max path value should be + between 1 - 255. The default is 1. ' - type: string - remote_as_num: - description: 'The remote AS number. - + format: int32 + type: integer + md5_secret: + description: 'The MD5 Secret should be between 1 and 32 characters. The + default value is 0. + ' type: string - route_map_in_id: - description: 'The ID of the Route Map In to filter incoming routes. + multi_hop_limit: + description: 'The BGP config multi hop limit. The multi-hop limit should + be between 1 - 255 hops. The default is 1 hop. ' - type: string - route_map_out_id: - description: 'The ID of the Route Map Out to filter outgoing routes. + format: int32 + type: integer + peer_auth_type: + description: 'The authentication type of the BGP peer. ' + enum: + - md5 + - none 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) ' + peer_retry_time: + description: 'The peer retry time should be between 0 - 65535 seconds. The + default is 120 seconds. + + ' + format: int32 + type: integer + prefix_adv_type: + description: 'The type of prefix advertisement; Default, Unaggregated or + Auto-aggregated. + + ' 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. + prefix_adv_type_to_lan: + description: 'The prefix advertises to LAN. ' - 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. + prefixes_to_adv_to_wan: + description: 'The prefix advertises to WAN. ' items: - description: Tags + description: Prefixes To Adv To Wan type: string type: array - update_source: - description: 'The Update Source IP address. + router_id: + description: 'The IP address of the ION device. Max size = 256. + + ' + type: string + stalepath_time: + description: 'The stale path time for the BGP config. The stalepath time + should be between 1 - 3600 seconds. The default is 120 seconds. + + ' + format: int32 + type: integer + BGPPeerAdvertisedPrefixes: + properties: + advertised_prefix_count: + description: 'The advertised prefix count for the BGP peer. + + ' + format: int32 + type: integer + advertised_prefixes: + $ref: '#/components/schemas/PrefixSet' + description: 'The advertised prefixes of the BGP peer. + + ' + id: + description: 'The ID of the BGP peer. + + ' + type: string + BGPPeerConfig: + properties: + 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 + name: + description: "The name of the BGP peer config. Max size = 128. \n" + 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 + remote_as_num: + description: 'The remote AS number. ' type: string - update_source_v6: - description: 'The Update Source IPv6 address. + route_map_in_id: + description: 'The ID of the Route Map In to filter incoming routes. ' type: string - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. + route_map_out_id: + description: 'The ID of the Route Map Out to filter outgoing routes. ' type: string + tags: + description: "A information field that can be added to identify the BGP\ + \ peer. Maximum 10 unique tags of length 1024 each are allowed. \n" + items: + description: Tags + type: string + type: array + update_source: + description: "The Update Source IP address. \n" + type: string required: - - allow_v6_prefixes - - allow_v4_prefixes - remote_as_num + - peer_ip - name - BGPPeerConfigV2N3: + BGPPeerConfigEtag: + properties: + id: + description: 'The BGP peer config etag ID. + + ' + type: string + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + type: string + required: + - tenant_id + BGPPeerConfigV2N1: properties: bgp_config: $ref: '#/components/schemas/BGPConfig' @@ -853,11 +849,6 @@ 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: @@ -884,26 +875,14 @@ 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 - BGPPeerConfigV2N4: + BGPPeerConfigV2N2: 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. @@ -922,12 +901,7 @@ components: ' type: string peer_ip: - description: 'The peer IP address. - - ' - type: string - peer_ip_v6: - description: "The peer IPv6 address. \n" + description: "The peer IP address. \n" type: string peer_type: description: 'The peer type = Classic. The Peer Type option is available @@ -950,18 +924,11 @@ 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. - - ' + 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 @@ -981,22 +948,11 @@ 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 BGPPeerDiscoveredPrefixes: properties: @@ -1016,90 +972,13 @@ components: id: description: 'The ID of the BGP peer. - ' - type: string - BGPPeerDiscoveredPrefixesV2N1: - 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. - - ' - type: string - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. - - ' - type: string - BGPPeerDiscoveredPrefixesV2N2: - 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 - 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 - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. - ' type: string BGPPeerOperations: properties: - action: - description: 'The BGP peer actions. - - ' - enum: - - HARD_RESET - - SOFT_RESET - - REVERT_AUTOGENERATED - - REFRESH_STATUS - type: string - id: - description: 'The ID of the BGP peer. - - ' + value: + description: Value type: string - required: - - action BGPPeerQuery: properties: aggregate: @@ -1169,7 +1048,7 @@ components: ' format: int64 type: integer - BGPPeerQueryFilterV2N2: + BGPPeerQueryFilter: properties: bgp_config: $ref: '#/components/schemas/BGPConfig' @@ -1212,18 +1091,6 @@ components: ' 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. @@ -1240,8 +1107,9 @@ components: type: string required: - remote_as_num + - peer_ip - name - BGPPeerQueryFilterV2N3: + BGPPeerQueryFilterV2N1: properties: bgp_config: $ref: '#/components/schemas/BGPConfig' @@ -1284,18 +1152,11 @@ 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. - - ' + 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 @@ -1315,29 +1176,17 @@ 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 - BGPPeerQueryFilterV2N4: + BGPPeerQueryFilterV2N2: 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. + bgp_config: + $ref: '#/components/schemas/BGPConfig' + description: 'The details of the BGP config. ' description: @@ -1353,12 +1202,7 @@ components: ' type: string peer_ip: - description: 'The peer IP address. - - ' - type: string - peer_ip_v6: - description: "The peer IPv6 address. \n" + description: "The peer IP address. \n" type: string peer_type: description: 'The peer type = Classic. The Peer Type option is available @@ -1379,19 +1223,13 @@ 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. Max size = 256. - ' 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. - - ' + 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 @@ -1411,22 +1249,11 @@ 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: properties: @@ -1461,66 +1288,8 @@ components: ' format: int32 type: integer - BGPPeerReachablePrefixesV2N1: - properties: - filtered_ipv4_prefixes: - description: 'The filtered 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. - - ' - format: int32 - type: integer - filtered_ipv6_prefixes: - description: 'The filtered IPv6 prefixes for the BGP peer. - - ' - items: - $ref: '#/components/schemas/PrefixInfo' - type: array - 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: - $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: - $ref: '#/components/schemas/PrefixInfo' - type: array - reachable_ipv6_prefixes_count: - description: 'The reachable IPv6 prefixes count for the BGP peer. - - ' - format: int32 - type: integer - BGPPeerStatusV2N1: + BGPPeerStatus: properties: - direction: - description: "The direction for the BGP peer. \n" - type: string downtime: description: 'The downtime configured for the BGP peer. @@ -1541,12 +1310,10 @@ components: ' type: string - BGPPeerStatusV2N2: + BGPPeerStatusV2N1: properties: direction: - description: 'The direction for the BGP peer. - - ' + description: "The direction for the BGP peer. \n" type: string downtime: description: 'The downtime configured for the BGP peer. @@ -1568,14 +1335,6 @@ components: ' type: string - v4_capability_negotiated: - description: "The v4 negotiated capability. \n" - type: boolean - v6_capability_negotiated: - description: 'The v6 negotiated capability. - - ' - type: boolean Direction: properties: {} EnterprisePrefixSetN: @@ -1598,36 +1357,6 @@ components: type: string required: - tenant_id - EnterprisePrefixSetNV2N1: - 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: Ipv4 Enterprise Prefixes - type: string - type: array - ipv6_enterprise_prefixes: - description: 'The IPv6 configuration of the tenant enterprise prefix. - - ' - items: - description: Ipv6 Enterprise Prefixes - type: string - type: array - tenant_id: - description: 'The tenant ID. - - ' - type: string - required: - - tenant_id Error: properties: _error: @@ -1739,11 +1468,6 @@ components: description: "The vlan ID. \n" format: int32 type: integer - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. - - ' - type: string LocalPrefixSet: properties: local_networks: @@ -1845,94 +1569,65 @@ components: ' type: string - PrefixQueryFilterV3: + PrefixSet: 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. + ipv4_set: + description: 'The set of The IPv4 addresses. ' - 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. + items: + description: Ipv4 Set + type: string + type: array + ipv6_set: + description: 'The set of The IPv6 addresses. ' - type: string - required: - - site_id - PrefixQueryFilterV3N1: + items: + description: Ipv6 Set + type: string + type: array + RoutingAccessList: properties: - element_id: - description: 'The element ID. - - ' - type: string - ipv4_prefix: - description: 'The IPv4 address prefix. + as_path_regex_list: + description: 'The AS Path Regex expression list. ' - type: string - ipv6_prefix: - description: 'The IPv6 address prefix. + 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 access list. \n" type: string - resource_id: - description: 'The resource ID. + name: + description: 'The name of the access list. Max size = 128. ' type: string - resource_type: - description: 'The resource type. + tags: + description: 'A information field that can be added to identify the access + list. Maximum 10 unique tags of length 1024 each are allowed. ' - 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 + items: + description: Tags + type: string + type: array required: - - site_id - PrefixQueryV3: + - name + RoutingAccessListQuery: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of prefix sets that match the query parameters. + description: 'The aggregate number of access/prefix lists that match the + query parameters. ' dest_page: @@ -1941,15 +1636,13 @@ components: ' format: int32 type: integer - ge: - type: integer getDeleted: - description: 'The number prefix sets deleted for a time frame. + description: 'The number of access/prefix lists deleted for a time frame. ' type: boolean group_by: - description: 'Group the prefix sets for the query. + description: 'Group the access/prefix lists for the query. ' items: @@ -1957,10 +1650,7 @@ components: type: string type: array id: - description: "List the prefix sets by ID. \n" - type: string - ipv4_prefix: - description: Ipv4 Prefix + 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. @@ -1968,8 +1658,6 @@ components: ' format: int64 type: integer - le: - type: integer limit: description: 'The query limit. @@ -1982,9 +1670,6 @@ components: ' type: object query_params: - description: 'Query using query parameters. - - ' type: object retrieved_fields: description: 'Retrieve information from a field. @@ -2000,261 +1685,50 @@ 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. - - ' + description: "The total number of query parameters. \n" format: int64 type: integer - PrefixQueryV3N1: + RoutingAccessListQueryFilter: properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of prefix sets that match the query parameters. + as_path_regex_list: + description: 'The AS Path Regex expression list. ' - dest_page: - description: 'The destination page. + 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 - ge: - type: integer - getDeleted: - description: 'The number prefix sets deleted for a time frame. + id: + description: "The peer IP address. \n" + type: string + name: + description: 'The name of the access list. Max size = 128. ' - type: boolean - group_by: - description: 'Group the prefix sets for the query. + 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: Group By + description: Tags type: string type: array - 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 - 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: - 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 access list. Max size = 1024. - - ' - id: - description: "The ID of the access list. \n" - type: string - name: - description: 'The name of the access list. Max size = 128. - - ' - 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: Tags - type: string - 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. - - ' - format: int32 - type: integer - 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 - 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. \n" - format: int64 - type: integer - RoutingAccessListQueryFilter: - 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 peer IP address. \n" - type: string - name: - description: 'The name of the access list. Max size = 128. - - ' - 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: Tags - type: string - type: array - required: - - name - RoutingAccessListQueryFilterV2N1: - properties: - as_path_regex_list: - description: 'The AS Path Regex expression list. + required: + - name + RoutingAccessListQueryFilterV2N1: + properties: + as_path_regex_list: + description: 'The AS Path Regex expression list. ' items: @@ -2584,11 +2058,6 @@ components: ' format: int32 type: integer - ipv6_prefix: - description: 'The IPv6 address prefix. - - ' - type: string le: description: "The prefix filter value for le operator should be within the\ \ range 1-32. \n" @@ -2610,39 +2079,8 @@ components: ' 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 + required: + - prefix RoutingPrefixList: properties: auto_generated: @@ -2717,7 +2155,7 @@ components: type: array required: - name - RoutingPrefixListQueryFilterV2N1: + RoutingPrefixListScreen: properties: auto_generated: description: 'The value true or false for auto-generated prefix list for @@ -2730,7 +2168,7 @@ components: ' id: - description: "The ID of the prefix list. \n" + description: "The ID of the prefix filter list. \n" type: string name: description: 'The name of the prefix filter list. Max size = 128. @@ -2741,7 +2179,7 @@ components: description: "The details of the prefix filter list used to filter routes.\ \ \n" items: - $ref: '#/components/schemas/RoutingPrefixFilterV2N1' + $ref: '#/components/schemas/RoutingPrefixFilter' type: array tags: description: 'A information field that can be added to identify the prefix @@ -2754,109 +2192,34 @@ components: type: array required: - name - RoutingPrefixListScreen: + RoutingRouteMap: properties: auto_generated: - description: 'The value true or false for auto-generated prefix list for - an element. + description: 'The value true or false for auto-generated route map for an + element. ' type: boolean description: - description: 'The description of the prefix filter list. Max size = 1024. + description: 'The description of the route map. Max size = 1024. ' id: - description: "The ID of the prefix filter list. \n" + description: "The ID of the route map. \n" type: string name: - description: 'The name of the prefix filter list. Max size = 128. + description: 'The name of the route map. 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. - - ' - items: - description: Tags - type: string - type: array - required: - - 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 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 - RoutingPrefixListV2N1: - 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" + route_map_entries: + description: "The details of the route map entries. \n" items: - $ref: '#/components/schemas/RoutingPrefixFilterV2N1' + $ref: '#/components/schemas/RoutingRouteMapEntry' 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 route + map. Maximum 10 unique tags of length 1024 each are allowed. ' items: @@ -2865,7 +2228,7 @@ components: type: array required: - name - RoutingRouteMapEntryV2N1: + RoutingRouteMapEntry: properties: continue_entry: description: 'To continue to use the rule that the route matches. @@ -2893,7 +2256,7 @@ components: description: 'The details of the route map set. ' - RoutingRouteMapEntryV2N2: + RoutingRouteMapEntryV2N1: properties: continue_entry: description: 'To continue to use the rule that the route matches. @@ -2990,7 +2353,7 @@ components: ' format: int64 type: integer - RoutingRouteMapQueryFilterV2N1: + RoutingRouteMapQueryFilter: properties: auto_generated: description: 'The value true or false for auto-generated route map for an @@ -3013,7 +2376,7 @@ components: route_map_entries: description: "The details of the route map entries. \n" items: - $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' + $ref: '#/components/schemas/RoutingRouteMapEntry' type: array tags: description: 'A information field that can be added to identify the route @@ -3026,7 +2389,7 @@ components: type: array required: - name - RoutingRouteMapQueryFilterV2N2: + RoutingRouteMapQueryFilterV2N1: properties: auto_generated: description: 'The value true or false for auto-generated route map for an @@ -3049,7 +2412,7 @@ components: route_map_entries: description: "The details of the route map entries. \n" items: - $ref: '#/components/schemas/RoutingRouteMapEntryV2N2' + $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' type: array tags: description: 'A information field that can be added to identify the route @@ -3062,7 +2425,7 @@ components: type: array required: - name - RoutingRouteMapScreenV2N1: + RoutingRouteMapScreen: properties: auto_generated: description: 'The value true or false for auto-generated route map for an @@ -3085,52 +2448,20 @@ components: route_map_entries: description: "The details of the route map entries. \n" items: - $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' + $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. \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. + 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 - 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: + RoutingRouteMapScreenV2N1: properties: auto_generated: description: 'The value true or false for auto-generated route map for an @@ -3164,7 +2495,7 @@ components: type: array required: - name - RoutingRouteMapV2N2: + RoutingRouteMapV2N1: properties: auto_generated: description: 'The value true or false for auto-generated route map for an @@ -3187,11 +2518,11 @@ components: route_map_entries: description: "The details of the route map entries. \n" items: - $ref: '#/components/schemas/RoutingRouteMapEntryV2N2' + $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" + \ map. Maximum 10 unique tags of length 1024 each are allowed. \n" items: description: Tags type: string @@ -3263,6 +2594,58 @@ components: ' type: boolean + StaticRoute: + properties: + 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 + network_context_id: + description: 'The ID of the network context. + + ' + type: string + 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: + - scope + - nexthops + - destination_prefix StaticRouteStatus: properties: id: @@ -3293,11 +2676,8 @@ components: items: $ref: '#/components/schemas/StateNextHop' type: array - StaticRouteV2N2: + StaticRouteV2N1: properties: - address_family: - description: "The static route address family. \n" - type: string description: description: 'The description of the static route. Max size = 256. @@ -3314,9 +2694,8 @@ components: ' type: string name: - description: 'The name of the static route. - - ' + 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. @@ -3324,9 +2703,7 @@ components: ' type: string nexthop_reachability_probe: - description: 'The Next Hop Reachability Probe is enabled. - - ' + description: Nexthop Reachability Probe type: boolean nexthops: description: 'The details of the next hops configured on the static route. @@ -3346,20 +2723,17 @@ components: - 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. - - ' + 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: - - address_family - scope - nexthops - destination_prefix - StaticRouteV2N3: + StaticRouteV2N2: properties: address_family: description: "The static route address family. \n" @@ -3420,1006 +2794,88 @@ components: 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. - - ' +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 - 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 + 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/RoutingAccessListScreen' - description: Details of the as-path access list to be updated + $ref: '#/components/schemas/EnterprisePrefixSetN' + description: Enterprise prefix Set 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) + 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}/routing_ipcommunitylists: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgpconfigs: 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: Get all BGP configs from NB + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -4436,180 +2892,100 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingCommunityList' + $ref: '#/components/schemas/BGPGlobalConfig' 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) + summary: Get all BGP configs from NB (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 + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgpconfigs/{bgp_config_id}: + get: + description: Get BGP config from NB + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 - 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. + - description: BGP config Id in: path - name: element_id + name: bgp_config_id required: true schema: - description: Element Id + description: Bgp Config 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 + $ref: '#/components/schemas/BGPGlobalConfig' 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 config from NB (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 + put: + description: Updates BGP config + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 IP community list. + - description: BGP Config Id in: path - name: config_id + name: bgp_config_id required: true schema: - description: Config Id + description: Bgp Config Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BGPGlobalConfigScreen' + description: Details of the bgp config to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingCommunityList' + $ref: '#/components/schemas/BGPGlobalConfig' description: Successful Operation '400': content: @@ -4617,100 +2993,106 @@ paths: example: value: _error: - - code: COMMUNITY_LIST_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_COMMUNITY_LIST + - 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: BGP_CONFIG_INVALID_MAXIMUM_PATHS + - code: BGP_CONFIG_INVALID_ADMIN_DISTANCE + - code: BGP_CONFIG_INVALID_PREFIX + - code: BGP_CONFIG_INVALID_STALEPATH_TIME schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Community List (v2.0) + summary: Updates BGP config (v2.0) tags: - Routing + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers: 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 all BGP Peer configs from NB + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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. - in: path - name: config_id - required: true - schema: - description: Config Id - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingCommunityList' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerConfig' + type: array + type: object description: Successful Operation - summary: Get Community List (v2.0) + summary: Get all BGP Peer configs from NB (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 + post: + description: Create BGP peer config + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 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 + $ref: '#/components/schemas/BGPGlobalConfigScreen' + description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingCommunityList' + $ref: '#/components/schemas/BGPPeerConfig' description: Successful Operation '400': content: @@ -4718,90 +3100,49 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_COMMUNITY_LIST + - 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_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 + - code: INVALID_PEER_CONFIG_FOR_SPOKE + - code: PEER_TYPE_NOT_SUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Prefix List for Element (v2.0) + summary: Create BGP peer config (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 + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/query: + post: + description: Queries db for limit number of BGP peers that match query params. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-query parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -4812,14 +3153,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixListScreen' - description: Details of the prefix list to be created + $ref: '#/components/schemas/BGPPeerQuery' + description: Query Details for BGP Peers responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixList' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerQueryFilter' + type: array + type: object description: Successful Operation '400': content: @@ -4827,116 +3175,95 @@ 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: BAD_QUERY_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create IP Prefix List (v2.0) + summary: Queries db for limit number of BGP peers that match query params. (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 + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/status: + get: + description: Get all BGP Peer status info from NB + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-status parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 - 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' + - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/RoutingPrefixListQueryFilter' + $ref: '#/components/schemas/BGPPeerStatus' 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 Prefix Lists (v2.0) + summary: Get all BGP Peer status info from NB (v2.0) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_prefixlists/{config_id}: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_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 BGP Peer config + operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 prefix list. + - description: BGP Peer Config Id in: path - name: config_id + name: bgp_peer_id required: true schema: - description: Config Id + description: Bgp Peer Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixList' + $ref: '#/components/schemas/BGPPeerConfig' description: Successful Operation '400': content: @@ -4944,100 +3271,99 @@ paths: example: value: _error: - - code: PREFIX_LIST_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_PREFIX_LIST + - code: PEER_CONFIG_INVALID_PEER_IP schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Prefix List (v2.0) + summary: Delete BGP Peer config (v2.0) 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 BGP Peer config + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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: BGP Peer Config Id in: path - name: config_id + name: bgp_peer_id required: true schema: - description: Config Id + description: Bgp Peer Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixList' + $ref: '#/components/schemas/BGPPeerConfig' description: Successful Operation - summary: Get Prefix List (v2.0) + summary: Get BGP Peer config (v2.0) 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 BGP Peer config + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 prefix list. + - description: BGP Peer Config Id in: path - name: config_id + name: bgp_peer_id required: true schema: - description: Config Id + description: Bgp Peer Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixListScreen' - description: Details of the prefix list to be updated + $ref: '#/components/schemas/BGPGlobalConfigScreen' + description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixList' + $ref: '#/components/schemas/BGPPeerConfig' description: Successful Operation '400': content: @@ -5045,19 +3371,32 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_PREFIX_LIST + - 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 schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Prefix List (v2.0) + summary: Updates BGP Peer config (v2.0) tags: - Routing - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/localprefixset: - get: - description: List the site local prefix set. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-localprefixset + /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 @@ -5073,20 +3412,50 @@ 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 + - 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/LocalPrefixSet' + $ref: '#/components/schemas/BGPPeerOperations' description: Successful Operation - summary: Get Site Local Prefix Set (v2.0) + '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}/vrfcontextprofiles: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/advertisedprefixes: get: - description: List all the VRF context profiles. - operationId: get-v2.0-api-tenants-tenant_id-vrfcontextprofiles + 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 @@ -5095,26 +3464,41 @@ 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. + 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/VRFContextProfile' - type: array - type: object + $ref: '#/components/schemas/BGPPeerAdvertisedPrefixes' description: Successful Operation - summary: Get VRF Context Profiles (v2.0) + summary: Get BGP Peer Advertised Prefixes (v2.0) tags: - Routing - post: - description: Create a new VRF context profile. - operationId: post-v2.0-api-tenants-tenant_id-vrfcontextprofiles + /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 @@ -5123,45 +3507,41 @@ paths: schema: description: Tenant Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VRFContextProfileScreen' - description: VRF Context Profile Request + - 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/VRFContextProfile' + $ref: '#/components/schemas/BGPPeerDiscoveredPrefixes' 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) + summary: Get BGP Discovered Prefixes (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 + /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 @@ -5170,163 +3550,84 @@ paths: 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: Query VRF Context Profiles (v2.0) - tags: - - Routing - /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. + - 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: tenant_id + name: element_id required: true schema: - description: Tenant Id + description: Element Id type: string - - description: The ID of the VRF context profile. + - description: The ID of the BGP peer config. in: path - name: vrf_context_profile_id + name: config_id required: true schema: - description: Vrf Context Profile Id + description: Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VRFContextProfile' + $ref: '#/components/schemas/BGPPeerReachablePrefixes' 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: Delete VRF Context Profile (v2.0) + summary: Get BGP Reachable Prefix (v2.0) tags: - Routing + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/status: get: - description: Get a VRF context profile. - operationId: get-v2.0-api-tenants-tenant_id-vrfcontextprofiles-vrf_context_profile_id + description: Get BGP Peer status info from NB + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-config_id-status parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the VRF context profile. + - description: Site Id in: path - name: vrf_context_profile_id + name: site_id required: true schema: - description: Vrf Context Profile Id + description: Site Id type: string - 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-v2.0-api-tenants-tenant_id-vrfcontextprofiles-vrf_context_profile_id - parameters: - - description: ID of the tenant. + - description: Element Id in: path - name: tenant_id + name: element_id required: true schema: - description: Tenant Id + description: Element Id type: string - - description: The ID of the VRF context profile. + - description: BGP Peer Config Id in: path - name: vrf_context_profile_id + name: config_id required: true schema: - description: Vrf Context Profile Id + description: Config 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/VRFContextProfile' + $ref: '#/components/schemas/BGPPeerStatus' 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: Update VRF Context Profile (v2.0) + summary: Get BGP Peer status info from NB (v2.0) tags: - Routing - /v2.0/api/tenants/{tenant_id}/vrfcontexts: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists: get: - description: Get a VRF segments. - operationId: get-v2.0-api-tenants-tenant_id-vrfcontexts + 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 @@ -5335,6 +3636,20 @@ 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: @@ -5345,16 +3660,26 @@ paths: - properties: items: items: - $ref: '#/components/schemas/VRFContext' + $ref: '#/components/schemas/RoutingAccessList' type: array type: object description: Successful Operation - summary: Get VRF Segments (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 Access List for Element (v2.0) tags: - Routing post: - description: Create a VRF segment. - operationId: post-v2.0-api-tenants-tenant_id-vrfcontexts + 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 @@ -5363,18 +3688,32 @@ 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/VRFContextScreen' - description: VRF Context Request + $ref: '#/components/schemas/RoutingAccessListScreen' + description: Details of the as-path access list to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VRFContext' + $ref: '#/components/schemas/RoutingAccessList' description: Successful Operation '400': content: @@ -5382,20 +3721,21 @@ paths: example: value: _error: - - code: VRF_CONTEXT_CONFIG_DESCRIPTION_INVALID - - code: VRF_CONTEXT_NAME_EXCEEDS_LIMIT - - code: VRF_CONTEXT_NAME_INVALID + - 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 VRF Segment (v2.0) + summary: Create AS-Path Access List (v2.0) tags: - Routing - /v2.0/api/tenants/{tenant_id}/vrfcontexts/query: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/query: post: - description: Query VRF contexts. - operationId: post-v2.0-api-tenants-tenant_id-vrfcontexts-query + 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 @@ -5404,12 +3744,26 @@ 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/VRFContextQuery' - description: Query Details for the Vrf Context + $ref: '#/components/schemas/RoutingAccessListQuery' + description: Query details for access lists responses: '200': content: @@ -5420,17 +3774,27 @@ paths: - properties: items: items: - $ref: '#/components/schemas/VRFContextQueryFilter' + $ref: '#/components/schemas/RoutingAccessListQueryFilter' type: array type: object description: Successful Operation - summary: Query VRF Contexts (v2.0) + '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}/vrfcontexts/{vrf_context_id}: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/{config_id}: delete: - description: Delete a VRF segment. - operationId: delete-v2.0-api-tenants-tenant_id-vrfcontexts-vrf_context_id + 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 @@ -5439,36 +3803,51 @@ paths: schema: description: Tenant Id type: string - - description: The ID of the VRF context. + - 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: vrf_context_id + name: config_id required: true schema: - description: Vrf Context Id + description: Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VRFContext' + $ref: '#/components/schemas/RoutingAccessList' description: Successful Operation - '404': + '400': content: application/json: example: value: _error: - - code: VRF_CONTEXT_NAME_INVALID + - code: ACCESS_LIST_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_ACCESS_LIST schema: $ref: '#/components/schemas/Error' - description: NOT FOUND - summary: Delete VRF Segment (v2.0) + description: Bad Request + summary: Delete Access List (v2.0) tags: - Routing get: - description: Get a VRF segment. - operationId: get-v2.0-api-tenants-tenant_id-vrfcontexts-vrf_context_id + 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 @@ -5477,36 +3856,40 @@ paths: schema: description: Tenant Id type: string - - description: The ID of the VRF context. + - 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: vrf_context_id + name: config_id required: true schema: - description: Vrf Context Id + description: Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VRFContext' + $ref: '#/components/schemas/RoutingAccessList' description: Successful Operation - '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) + summary: Get Access List (v2.0) tags: - Routing put: - description: Update a VRF context. - operationId: put-v2.0-api-tenants-tenant_id-vrfcontexts-vrf_context_id + 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 @@ -5515,25 +3898,39 @@ paths: schema: description: Tenant Id type: string - - description: The ID of the VRF context. + - 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: vrf_context_id + name: config_id required: true schema: - description: Vrf Context Id + description: Config Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/VRFContextScreen' - description: Details of vrf segment to be updated + $ref: '#/components/schemas/RoutingAccessListScreen' + description: Details of the as-path access list to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VRFContext' + $ref: '#/components/schemas/RoutingAccessList' description: Successful Operation '400': content: @@ -5541,19 +3938,19 @@ paths: example: value: _error: - - code: VRF_CONTEXT_CONFIG_DESCRIPTION_INVALID - - code: VRF_CONTEXT_NAME_EXCEEDS_LIMIT - - code: VRF_CONTEXT_NAME_INVALID + - 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 VRF Context (v2.0) + summary: Update Access List (v2.0) tags: - Routing - /v2.1/api/tenants/{tenant_id}/enterpriseprefixset: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_ipcommunitylists: get: - description: List the prefix set of a tenant enterprise. - operationId: get-v2.1-api-tenants-tenant_id-enterpriseprefixset + 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 @@ -5562,47 +3959,50 @@ paths: schema: description: Tenant Id type: string - 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. + - description: The ID of the site. in: path - name: tenant_id + name: site_id required: true schema: - description: Tenant Id + 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/EnterprisePrefixSetNV2N1' - description: Enterprise prefix Set responses: '200': content: application/json: schema: - $ref: '#/components/schemas/EnterprisePrefixSetNV2N1' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingCommunityList' + type: array + type: object description: Successful Operation - summary: Update Tenant Enterprise Prefix Set (v2.1) + '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 - /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 + 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 @@ -5625,27 +4025,43 @@ 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: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/BGPPeerStatusV2N1' - type: array - type: object + $ref: '#/components/schemas/RoutingCommunityList' description: Successful Operation - summary: Get BGP Peer Status 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: 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.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 + /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 @@ -5668,27 +4084,44 @@ paths: 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingCommunityListQuery' + description: Query details for Routing Community responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerAdvertisedPrefixesV2N1' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingCommunityListQueryFilter' + type: array + type: object description: Successful Operation - summary: Get BGP Peer Advertised Prefixes (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 Community Lists (v2.0) tags: - Routing - /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 + /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 @@ -5711,27 +4144,37 @@ paths: schema: description: Element Id type: string - - description: The BGP peer config ID. + - description: The ID of the IP community list. in: path - name: bgp_peer_config_id + name: config_id required: true schema: - description: Bgp Peer Config Id + description: Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerReachablePrefixesV2N1' + $ref: '#/components/schemas/RoutingCommunityList' description: Successful Operation - summary: Get BGP Reachable Prefix Information (v2.1) + '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 - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/discoveredprefixes: get: - description: Get BGP discovered prefix information. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-config_id-discoveredprefixes + 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 @@ -5766,15 +4209,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BGPPeerDiscoveredPrefixesV2N1' + $ref: '#/components/schemas/RoutingCommunityList' description: Successful Operation - summary: Get BGP Discovered Prefix Information (v2.1) + summary: Get Community List (v2.0) tags: - Routing - /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 + 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 @@ -5797,27 +4239,48 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer config. + - 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/BGPPeerStatusV2N1' + $ref: '#/components/schemas/RoutingCommunityList' description: Successful Operation - summary: Get BGP Peer Status from NB (v2.1) + '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.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_prefixlists: 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: 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 @@ -5850,12 +4313,9 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingPrefixList' type: array type: object - items: - $ref: '#/components/schemas/RoutingAccessListV2N1' - type: array description: Successful Operation '400': content: @@ -5867,12 +4327,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Access List for Element (v2.1) + summary: Get Prefix List for Element (v2.0) 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 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 @@ -5899,14 +4359,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListScreenV2N1' - description: Details of the as-path access list 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/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingPrefixList' description: Successful Operation '400': content: @@ -5921,14 +4381,14 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create AS-Path Access List (v2.1) + summary: Create IP Prefix List (v2.0) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/query: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_prefixlists/query: post: - 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 + 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 @@ -5967,7 +4427,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingAccessListQueryFilterV2N1' + $ref: '#/components/schemas/RoutingPrefixListQueryFilter' type: array type: object description: Successful Operation @@ -5982,13 +4442,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Access Lists (v2.1) + summary: Query DB for Prefix Lists (v2.0) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/{config_id}: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_prefixlists/{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 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 @@ -6011,7 +4471,7 @@ paths: schema: description: Element Id type: string - - description: The ID of the access list. + - description: The ID of the prefix list. in: path name: config_id required: true @@ -6023,7 +4483,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingPrefixList' description: Successful Operation '400': content: @@ -6031,17 +4491,17 @@ paths: example: value: _error: - - code: ACCESS_LIST_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_ACCESS_LIST + - code: PREFIX_LIST_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_PREFIX_LIST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Access List (v2.1) + summary: Delete Prefix List (v2.0) 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 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 @@ -6076,14 +4536,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingPrefixList' description: Successful Operation - summary: Get Access List (v2.1) + summary: Get Prefix List (v2.0) 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 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 @@ -6106,7 +4566,7 @@ paths: schema: description: Element Id type: string - - description: The ID of the access list. + - description: The ID of the prefix list. in: path name: config_id required: true @@ -6117,14 +4577,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' - description: Details of the access list to be updated + $ref: '#/components/schemas/RoutingPrefixListScreen' + description: Details of the prefix list to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingPrefixList' description: Successful Operation '400': content: @@ -6132,35 +4592,35 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_ACCESS_LIST + - 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 Access List (v2.1) + summary: Update Prefix List (v2.0) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_prefixlists: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps: get: - 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 + description: Get all Route Map for Element + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -6177,7 +4637,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingPrefixListV2N1' + $ref: '#/components/schemas/RoutingRouteMap' type: array type: object description: Successful Operation @@ -6191,28 +4651,28 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Prefix List for Element (v2.1) + summary: Get all Route Map for Element (v2.0) tags: - Routing post: - description: Create an IP Prefix List. - operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists + description: Create Route Map + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -6223,14 +4683,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixListScreenV2N1' - description: Details of the prefix list to be created + $ref: '#/components/schemas/RoutingRouteMapScreen' + description: Details of route map to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixListV2N1' + $ref: '#/components/schemas/RoutingRouteMap' description: Successful Operation '400': content: @@ -6242,34 +4702,41 @@ paths: - code: ELEMENT_NOT_ASSIGNED_TO_SITE - code: NOT_SUPPORTED_BY_ELEMENT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: PREFIX_LIST_PREFIX_NOT_SUPPORTED + - 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 schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create IP Prefix List (v2.1) + summary: Create Route Map (v2.0) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_prefixlists/query: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps/query: post: - 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 + description: Queries db for limit number of route maps that match query params. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-query parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -6280,8 +4747,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: @@ -6292,7 +4759,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingPrefixListQueryFilterV2N1' + $ref: '#/components/schemas/RoutingRouteMapQueryFilter' type: array type: object description: Successful Operation @@ -6303,52 +4770,52 @@ paths: 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.1) + summary: Queries db for limit number of route maps that match query params. + (v2.0) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_prefixlists/{routing_prefixlist_id}: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps/{config_id}: delete: - description: Delete a prefix list. - operationId: delete-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists-routing_prefixlist_id + description: Delete Route Map + operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 routing prefix list ID. + - description: Route Map Id in: path - name: routing_prefixlist_id + name: config_id required: true schema: - description: Routing Prefixlist Id + description: Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixListV2N1' + $ref: '#/components/schemas/RoutingRouteMap' description: Successful Operation '400': content: @@ -6356,100 +4823,100 @@ paths: example: value: _error: - - code: PREFIX_LIST_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_PREFIX_LIST + - code: ROUTE_MAP_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_ROUTE_MAP schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Prefix List (v2.1) + summary: Delete Route Map (v2.0) tags: - Routing get: - description: Get a prefix list. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists-routing_prefixlist_id + description: Get Specific Route Map + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 routing prefix list ID. + - description: BGP Peer Config Id in: path - name: routing_prefixlist_id + name: config_id required: true schema: - description: Routing Prefixlist Id + description: Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixListV2N1' + $ref: '#/components/schemas/RoutingRouteMap' description: Successful Operation - summary: Get Prefix List (v2.1) + summary: Get Specific Route Map (v2.0) tags: - Routing put: - description: Update a prefix list. - operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_prefixlists-routing_prefixlist_id + description: Updates Route Map + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 routing prefix list ID. + - description: Route Map Id in: path - name: routing_prefixlist_id + name: config_id required: true schema: - description: Routing Prefixlist Id + description: Config Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixListScreenV2N1' - description: Details of the prefix list to be updated + $ref: '#/components/schemas/RoutingRouteMapScreen' + description: Details of route map to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixListV2N1' + $ref: '#/components/schemas/RoutingRouteMap' description: Successful Operation '400': content: @@ -6457,36 +4924,44 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_PREFIX_LIST + - code: CANNOT_UPDATE_AUTOGENERATED_ROUTE_MAP - 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 Prefix List (v2.1) + summary: Updates Route Map (v2.0) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps: + /v2.0/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: Get static routes + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes parameters: - - description: ID of the tenant. + - description: Tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -6503,42 +4978,32 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + $ref: '#/components/schemas/StaticRoute' 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.0) 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 static route + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes parameters: - - description: ID of the tenant. + - description: Tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -6549,14 +5014,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapV2N1' - description: Details of the route map to be created + $ref: '#/components/schemas/StaticRoute' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + $ref: '#/components/schemas/StaticRoute' description: Successful Operation '400': content: @@ -6564,229 +5028,148 @@ 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: 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}/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 - 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/RoutingRouteMapQuery' - description: Query details for route maps - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/RoutingRouteMapQueryFilterV2N1' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_REQUEST - - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: STATICROUTE_CONFIG_INVALID_DEVICE + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP + - code: INTERFACE_NOT_FOUND + - code: INVALID_NETWORK_CONTEXT + - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Route Maps (v2.1) + summary: Create static route (v2.0) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps/{config_id}: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_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 + description: Delete static route + operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id parameters: - - description: ID of the tenant. + - description: Tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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: Static Route ID 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/StaticRoute' description: Successful Operation - '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) + summary: Delete static route (v2.0) tags: - Routing 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 static route + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id parameters: - - description: ID of the tenant. + - description: Tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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: Static Route ID 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/StaticRoute' description: Successful Operation - summary: Get Route Map (v2.1) + summary: Get static route (v2.0) 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 + description: Update static route + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id parameters: - - description: ID of the tenant. + - description: Tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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: Static Route ID 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/RoutingRouteMapV2N1' - description: Details of the route map to be updated + $ref: '#/components/schemas/StaticRoute' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + $ref: '#/components/schemas/StaticRoute' description: Successful Operation '400': content: @@ -6794,30 +5177,24 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_ROUTE_MAP + - 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: ROUTE_MAP_ENTRY_WITH_RESERVED_ORDER + - code: STATICROUTE_CONFIG_INVALID_DEVICE + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP + - code: INTERFACE_NOT_FOUND + - code: INVALID_NETWORK_CONTEXT + - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Route Map (v2.1) + summary: Update static route (v2.0) tags: - Routing - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}/status: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/localprefixset: 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 + 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 @@ -6833,50 +5210,36 @@ 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 - - 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' + $ref: '#/components/schemas/LocalPrefixSet' description: Successful Operation - summary: Get Static Route Status (v2.1) + summary: Get Site Local Prefix Set (v2.0) tags: - Routing - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgpconfigs: + /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.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs + description: Get all BGP configs from NB + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -6893,40 +5256,40 @@ paths: - properties: items: items: - $ref: '#/components/schemas/BGPGlobalConfigV2N2' + $ref: '#/components/schemas/BGPGlobalConfigV2N1' type: array type: object description: Successful Operation - summary: Get BGP Configs from NB (v2.2) + summary: Get all BGP configs from NB (v2.1) tags: - Routing - /v2.2/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}/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 BGP config from NB + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 BGP config. + - description: BGP config Id in: path name: bgp_config_id required: true @@ -6938,37 +5301,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigV2N2' + $ref: '#/components/schemas/BGPGlobalConfigV2N1' description: Successful Operation - summary: Get BGP Config from NB (v2.2) + summary: Get BGP config from NB (v2.1) 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: Updates BGP config + operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 BGP config. + - description: BGP Config Id in: path name: bgp_config_id required: true @@ -6979,14 +5342,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigScreenV2N2' + $ref: '#/components/schemas/BGPGlobalConfigScreenV2N1' description: Details of the bgp config to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigV2N2' + $ref: '#/components/schemas/BGPGlobalConfigV2N1' description: Successful Operation '400': content: @@ -6994,7 +5357,7 @@ paths: example: value: _error: - - code: BGP_CONFIG_INVALID_LOCAL_AS_NUMBER + - 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 @@ -7004,34 +5367,32 @@ paths: - 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) + summary: Updates BGP config (v2.1) tags: - Routing - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/status: + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers: 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 + description: Get all BGP Peer configs from NB + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -7048,103 +5409,146 @@ paths: - properties: items: items: - $ref: '#/components/schemas/BGPPeerStatusV2N2' + $ref: '#/components/schemas/BGPPeerConfigEtag' type: array type: object description: Successful Operation - summary: Get BGP Peer Status from NB (v2.2) + summary: Get all BGP Peer configs from NB (v2.1) 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 + post: + description: Create BGP peer config + operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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. - in: path - name: bgp_peer_config_id - required: true - schema: - 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/BGPPeerDiscoveredPrefixesV2N2' + $ref: '#/components/schemas/BGPPeerConfigV2N1' description: Successful Operation - summary: Get BGP Discovered Prefix Information (v2.2) + '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) tags: - Routing - /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.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-config_id-status + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/query: + post: + description: Queries db for limit number of BGP peers that match query params. + operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-query parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 BGP peer config. - in: path - name: config_id - required: true - schema: - description: Config 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/BGPPeerStatusV2N2' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerQueryFilterV2N1' + type: array + type: object description: Successful Operation - summary: Get BGP Peer Status from NB (v2.2) + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Queries db for limit number of BGP peers that match query params. (v2.1) tags: - Routing - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps: + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/status: get: - 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 + 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 @@ -7177,189 +5581,142 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N2' + $ref: '#/components/schemas/BGPPeerStatusV2N1' 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.2) + summary: Get BGP Peer Status from NB (v2.1) tags: - Routing - post: - description: Create a route map. - operationId: post-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_id}: + delete: + description: Delete BGP Peer config + operationId: delete-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RoutingRouteMapV2N2' - description: Details of the route map to be created + - description: BGP Peer Config Id + in: path + name: bgp_peer_id + required: true + schema: + description: Bgp Peer Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N2' + $ref: '#/components/schemas/BGPPeerConfigV2N1' 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: 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.2) + summary: Delete BGP Peer config (v2.1) tags: - Routing - /v2.2/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.2-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-query + get: + description: Get BGP Peer config + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RoutingRouteMapQuery' - description: Query details for route maps + - description: BGP Peer Config Id + 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/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/RoutingRouteMapQueryFilterV2N2' - type: array - type: object + $ref: '#/components/schemas/BGPPeerConfigV2N1' 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 Route Maps (v2.2) + summary: Get BGP Peer config (v2.1) tags: - Routing - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps/{config_id}: - delete: - description: Delete a route map. - operationId: delete-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-config_id + put: + description: Updates BGP Peer config + operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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: BGP Peer Config Id in: path - name: config_id + name: bgp_peer_id required: true schema: - description: Config Id + 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/RoutingRouteMapScreenV2N2' + $ref: '#/components/schemas/BGPPeerConfigV2N1' description: Successful Operation '400': content: @@ -7367,17 +5724,35 @@ paths: example: value: _error: - - code: ROUTE_MAP_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_ROUTE_MAP + - 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: Delete Route Map (v2.2) + summary: Updates BGP Peer config (v2.1) tags: - Routing + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/status: get: - description: Get a specific route map. - operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-routing_routemaps-config_id + 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 @@ -7400,7 +5775,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 @@ -7412,14 +5787,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N2' + $ref: '#/components/schemas/BGPPeerStatusV2N1' description: Successful Operation - summary: Get Route Map (v2.2) + summary: Get BGP Peer Status from NB (v2.1) tags: - Routing - put: - description: Update a route map. - operationId: put-v2.2-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_aspathaccesslists: + 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 parameters: - description: ID of the tenant. in: path @@ -7442,25 +5818,22 @@ 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/RoutingRouteMapV2N2' - description: Details of the route map to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N2' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingAccessListV2N1' + type: array + type: object + items: + $ref: '#/components/schemas/RoutingAccessListV2N1' + type: array description: Successful Operation '400': content: @@ -7468,30 +5841,16 @@ 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: ROUTE_MAP_ENTRY_WITH_RESERVED_ORDER + - code: ELEMENT_NOT_ASSIGNED_TO_SITE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Route Map (v2.2) + summary: Get Access List for Element (v2.1) 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 + post: + 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 @@ -7514,26 +5873,40 @@ paths: schema: description: Element Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingAccessListScreenV2N1' + description: Details of the as-path access list to be created responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/StaticRouteV2N2' - type: array - type: object + $ref: '#/components/schemas/RoutingAccessListV2N1' description: Successful Operation - summary: Get Static Routes (v2.2) + '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.1) tags: - Routing + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/query: post: - description: Create a static route. - operationId: post-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes + 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 @@ -7560,13 +5933,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/RoutingAccessListQuery' + description: Query details for access lists responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingAccessListQueryFilterV2N1' + type: array + type: object description: Successful Operation '400': content: @@ -7574,36 +5955,18 @@ paths: 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_REQUEST + - code: ELEMENT_NOT_ASSIGNED_TO_SITE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Static Route (v2.2) + summary: Query DB for Access Lists (v2.1) tags: - Routing - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}: + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/{config_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 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 @@ -7626,19 +5989,19 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. + - description: The ID of the access list. in: path - name: static_route_id + name: config_id required: true schema: - description: Static Route Id + description: Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/RoutingAccessListV2N1' description: Successful Operation '400': content: @@ -7646,16 +6009,17 @@ paths: example: value: _error: - - code: STATICROUTE_CONFIG_INVALID_DEVICE + - code: ACCESS_LIST_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_ACCESS_LIST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Static Route (v2.2) + summary: Delete Access List (v2.1) 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 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 @@ -7678,26 +6042,26 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. + - description: The BGP peer config ID. in: path - name: static_route_id + name: config_id required: true schema: - description: Static Route Id + description: Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/RoutingAccessListV2N1' description: Successful Operation - summary: Get Static Route (v2.2) + summary: Get Access List (v2.1) 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: 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 @@ -7720,24 +6084,25 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. + - description: The ID of the access list. in: path - name: static_route_id + name: config_id required: true schema: - description: Static Route Id + description: Config Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/RoutingAccessListV2N1' + description: Details of the access list to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/RoutingAccessListV2N1' description: Successful Operation '400': content: @@ -7745,36 +6110,19 @@ paths: example: value: _error: - - code: INVALID_JSON_INPUT + - code: CANNOT_UPDATE_AUTOGENERATED_ACCESS_LIST - 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 schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Static Route (v2.2) + summary: Update Access List (v2.1) tags: - Routing - /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}/status: + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps: 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 + 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 @@ -7797,28 +6145,103 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + 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) + tags: + - Routing + 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 - name: static_route_id + name: tenant_id required: true schema: - description: Static Route Id + 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/RoutingRouteMapV2N1' + description: Details of the route map to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteStatusV2N2' - description: Successful Operation - summary: Get Static Route Status (v2.2) + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + 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: 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 + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Route Map (v2.1) tags: - Routing - /v2.3/api/tenants/{tenant_id}/bgppeers/query: + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/routing_routemaps/query: post: - description: Queries the DB for limit number of BGP peers that match the query + description: Queries the DB for limit number of route maps that match the query parameters. - operationId: post-v2.3-api-tenants-tenant_id-bgppeers-query + 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 @@ -7827,12 +6250,26 @@ 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/BGPPeerQuery' - description: Query Details for BGP Peers + $ref: '#/components/schemas/RoutingRouteMapQuery' + description: Query details for route maps responses: '200': content: @@ -7843,7 +6280,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/BGPPeerQueryFilterV2N3' + $ref: '#/components/schemas/RoutingRouteMapQueryFilterV2N1' type: array type: object description: Successful Operation @@ -7853,17 +6290,18 @@ paths: example: value: _error: - - code: BAD_QUERY_REQUEST + - code: BAD_REQUEST + - code: ELEMENT_NOT_ASSIGNED_TO_SITE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for BGP Peers (v2.3) + summary: Query DB for Route Maps (v2.1) tags: - Routing - /v2.3/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgpconfigs: - get: - description: List all the BGP configurations from NB. - operationId: get-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs + /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 @@ -7886,27 +6324,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/BGPGlobalConfigV2N3' - type: array - type: object + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' description: Successful Operation - summary: Get BGP Configs from NB (v2.3) + '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 - /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 + 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 @@ -7929,26 +6377,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/BGPGlobalConfigV2N3' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' description: Successful Operation - summary: Get BGP Config from NB (v2.3) + summary: Get Route Map (v2.1) tags: - Routing put: - description: Update the BGP configuration. - operationId: put-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id + 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 @@ -7971,25 +6419,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/BGPGlobalConfigScreenV2N3' - 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/BGPGlobalConfigV2N3' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' description: Successful Operation '400': content: @@ -7997,44 +6445,45 @@ paths: 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: CANNOT_UPDATE_AUTOGENERATED_ROUTE_MAP - 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 + - 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 schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update BGP Config (v2.3) + summary: Update Route Map (v2.1) tags: - Routing - /v2.3/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers: + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes: get: - description: List all the BGP peer configurations from NB. - operationId: get-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers + description: Get static routes + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes parameters: - - description: ID of the tenant. + - description: Tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -8051,32 +6500,32 @@ paths: - properties: items: items: - $ref: '#/components/schemas/BGPPeerConfigV2N3' + $ref: '#/components/schemas/StaticRouteV2N1' type: array type: object description: Successful Operation - summary: Get BGP Peer Configs from NB (v2.3) + summary: Get static routes (v2.1) tags: - Routing post: - description: Create a BGP peer configuration. - operationId: post-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers + description: Create static route + operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes parameters: - - description: ID of the tenant. + - description: Tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -8087,14 +6536,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigScreenV2N3' - description: Details of the BGP peer config to be created + $ref: '#/components/schemas/StaticRouteV2N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N3' + $ref: '#/components/schemas/StaticRouteV2N1' description: Successful Operation '400': content: @@ -8102,180 +6550,177 @@ 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_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.3) + summary: Create static route (v2.1) tags: - Routing - /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 + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}: + delete: + description: Delete static route + operationId: delete-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id parameters: - - description: ID of the tenant. + - description: Tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BGPPeerQuery' - description: Query Details for BGP Peers + - description: Static Route ID + 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/StaticRouteV2N1' 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.3) + summary: Delete static route (v2.1) tags: - Routing - /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 + get: + description: Get static route + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id parameters: - - description: ID of the tenant. + - description: Tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 BGP peer. + - description: Static Route ID 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/BGPPeerConfigV2N3' + $ref: '#/components/schemas/StaticRouteV2N1' description: Successful Operation - summary: Delete BGP Peer Config (v2.3) + summary: Get static route (v2.1) tags: - Routing - get: - description: Get the BGP peer configuration. - operationId: get-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + put: + description: Update static route + operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes-static_route_id parameters: - - description: ID of the tenant. + - description: Tenant ID in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 BGP peer. + - description: Static Route ID in: path - name: bgp_peer_id + name: static_route_id required: true schema: - description: Bgp Peer Id + description: Static Route Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StaticRouteV2N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N3' + $ref: '#/components/schemas/StaticRouteV2N1' description: Successful Operation - summary: Get BGP Peer Config (v2.3) + '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: Update static route (v2.1) tags: - Routing - put: - description: Update the BGP peer configuration. - operationId: put-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + /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 @@ -8298,25 +6743,54 @@ 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: 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 db for BGP peers that match query params. + operationId: post-v2.2-api-tenants-tenant_id-bgppeers-query + parameters: + - description: Tenant Id + in: path + name: tenant_id required: true schema: - description: Bgp Peer Id + description: Tenant Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigScreenV2N3' - description: Details of the BGP peer config to be created + $ref: '#/components/schemas/BGPPeerQuery' + description: Query Details for BGP Peers responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N3' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerQueryFilterV2N2' + type: array + type: object description: Successful Operation '400': content: @@ -8324,37 +6798,17 @@ 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_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 + - code: BAD_QUERY_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update BGP Peer Config (v2.3) + summary: Queries db for BGP peers that match query params. (v2.2) tags: - Routing - /v2.3/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/staticroutes: + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgpconfigs: get: - description: List all the static routes. - operationId: get-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes + 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 @@ -8387,16 +6841,17 @@ paths: - properties: items: items: - $ref: '#/components/schemas/StaticRouteV2N3' + $ref: '#/components/schemas/BGPGlobalConfigV2N2' type: array type: object description: Successful Operation - summary: Get Static Routes (v2.3) + summary: Get BGP Configs from NB (v2.2) tags: - Routing - post: - description: Create a static route. - operationId: post-v2.3-api-tenants-tenant_id-sites-site_id-elements-element_id-staticroutes + /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 @@ -8419,54 +6874,26 @@ paths: schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StaticRouteV2N3' + - 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/StaticRouteV2N3' + $ref: '#/components/schemas/BGPGlobalConfigV2N2' 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: Create Static Route (v2.3) + summary: Get BGP Config from NB (v2.2) tags: - Routing - /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 + 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 @@ -8489,19 +6916,25 @@ 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/BGPGlobalConfigScreenV2N2' + description: Details of the bgp config to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N3' + $ref: '#/components/schemas/BGPGlobalConfigV2N2' description: Successful Operation '400': content: @@ -8509,98 +6942,104 @@ paths: example: value: _error: - - code: STATICROUTE_CONFIG_INVALID_DEVICE + - 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: Delete Static Route (v2.3) + summary: Update BGP Config (v2.2) tags: - Routing + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers: 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 + description: Get all BGP Peer configs from NB + operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 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/StaticRouteV2N3' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerConfigV2N2' + type: array + type: object description: Successful Operation - summary: Get Static Route (v2.3) + summary: Get all BGP Peer configs from NB (v2.2) 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 + post: + description: Create BGP peer config + operationId: post-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 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' + $ref: '#/components/schemas/BGPGlobalConfigScreenV2N2' + description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N3' + $ref: '#/components/schemas/BGPPeerConfigV2N2' description: Successful Operation '400': content: @@ -8608,45 +7047,59 @@ 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: 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.3) + summary: Create BGP peer config (v2.2) tags: - Routing - /v2.4/api/tenants/{tenant_id}/bgppeers/query: + /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 the query - parameters. - operationId: post-v2.4-api-tenants-tenant_id-bgppeers-query + description: Queries db for limit number of BGP peers that match query params. + operationId: post-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-query parameters: - - description: ID of the tenant. + - description: Tenant Id 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string requestBody: content: application/json: @@ -8663,7 +7116,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/BGPPeerQueryFilterV2N4' + $ref: '#/components/schemas/BGPPeerQueryFilterV2N2' type: array type: object description: Successful Operation @@ -8677,89 +7130,138 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for BGP Peers (v2.4) + summary: Queries db for limit number of BGP peers that match query params. (v2.2) tags: - Routing - /v2.4/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers: - get: - description: List all the BGP peer configurations from NB. - operationId: get-v2.4-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_id}: + delete: + description: Delete BGP Peer config + operationId: delete-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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: BGP Peer Config Id + 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/BGPPeerConfigV2N4' - type: array - type: object + $ref: '#/components/schemas/BGPPeerConfigV2N2' + description: Successful Operation + summary: Delete BGP Peer config (v2.2) + tags: + - Routing + get: + description: Get BGP Peer config + operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + parameters: + - description: Tenant Id + 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: BGP Peer Config Id + 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' description: Successful Operation - summary: Get BGP Peer Configs from NB (v2.4) + summary: Get BGP Peer config (v2.2) tags: - Routing - post: - description: Create a BGP peer configuration. - operationId: post-v2.4-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers + put: + description: Updates BGP Peer config + operationId: put-v2.2-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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: BGP Peer Config Id + in: path + name: bgp_peer_id + required: true + schema: + description: Bgp Peer Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigScreenV2N4' + $ref: '#/components/schemas/BGPGlobalConfigScreenV2N2' description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N4' + $ref: '#/components/schemas/BGPPeerConfigV2N2' description: Successful Operation '400': content: @@ -8783,22 +7285,21 @@ 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_PEER_IP_CONFIG_NOT_SUPPORTED + - code: BGP_CONFIG_INVALID_MD5_UNSET_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create BGP Peer Config (v2.4) + summary: Updates BGP Peer config (v2.2) tags: - Routing - /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 + /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 parameters: - description: ID of the tenant. in: path @@ -8821,43 +7322,96 @@ 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/BGPPeerQueryFilterV2N4' + $ref: '#/components/schemas/StaticRouteV2N2' 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: BAD_QUERY_REQUEST + - 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: Query DB for BGP Peers (v2.4) + summary: Create Static Route (v2.2) tags: - Routing - /v2.4/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}/staticroutes/{static_route_id}: delete: - description: Delete the BGP peer configuration. - operationId: delete-v2.4-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + 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 @@ -8880,26 +7434,36 @@ 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/BGPPeerConfigV2N4' + $ref: '#/components/schemas/StaticRouteV2N2' description: Successful Operation - summary: Delete BGP Peer Config (v2.4) + '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) tags: - Routing get: - description: Get the BGP peer configuration. - operationId: get-v2.4-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + 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 @@ -8922,26 +7486,26 @@ 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/BGPPeerConfigV2N4' + $ref: '#/components/schemas/StaticRouteV2N2' description: Successful Operation - summary: Get BGP Peer Config (v2.4) + summary: Get Static Route (v2.2) tags: - Routing put: - description: Update the BGP peer configuration. - operationId: put-v2.4-api-tenants-tenant_id-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + 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 @@ -8964,25 +7528,24 @@ 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigScreenV2N4' - description: Details of the BGP peer config to be created + $ref: '#/components/schemas/StaticRouteV2N2' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N4' + $ref: '#/components/schemas/StaticRouteV2N2' description: Successful Operation '400': content: @@ -8990,122 +7553,73 @@ 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: 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 + - 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 BGP Peer Config (v2.4) + summary: Update Static Route (v2.2) tags: - Routing - /v3.0/api/tenants/{tenant_id}/prefixes/query: - post: - description: Query the prefix set. - operationId: post-v3.0-api-tenants-tenant_id-prefixes-query + /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 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/PrefixQueryV3' - description: Query Details for prefixes - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/PrefixQueryFilterV3' - 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 Prefix Set (3.0) - tags: - - Routing - /v3.1/api/tenants/{tenant_id}/prefixes/query: - post: - description: Query the prefix set. - operationId: post-v3.1-api-tenants-tenant_id-prefixes-query - parameters: - - description: The tenant ID. + - description: The ID of the site. in: path - name: tenant_id + name: site_id required: true schema: - description: Tenant Id + 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/PrefixQueryV3N1' - description: Query Details for prefixes responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/PrefixQueryFilterV3N1' - type: array - type: object + $ref: '#/components/schemas/StaticRouteStatusV2N2' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_QUERY_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Prefix Set (3.1) + summary: Get Static Route Status (v2.2) tags: - Routing servers: diff --git a/openapi-specs/sdwan/legacy/SecurityPolicy.yaml b/openapi-specs/sdwan/legacy/SecurityPolicy.yaml index 7b86cb1bf..f1d9b5812 100644 --- a/openapi-specs/sdwan/legacy/SecurityPolicy.yaml +++ b/openapi-specs/sdwan/legacy/SecurityPolicy.yaml @@ -2,21 +2,9 @@ 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: @@ -26,28 +14,6 @@ components: - 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 ElementSecurityZone: properties: id: @@ -331,6 +297,10 @@ components: ' type: string + required: + - path + - site + - elements GlobalPrefixQueryFilter: properties: description: @@ -368,48 +338,6 @@ components: type: array required: - name - GlobalPrefixQueryFilterV2N1: - properties: - description: - description: 'The description of the priority policy global prefix. - - ' - id: - description: 'The ID of the priority policy global prefix. - - ' - type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the priority policy global prefix. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'Lists the IPv6 addresses of the priority policy global prefix. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - name: - description: 'The name of the priority policy global prefix. - - ' - 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. \n" - items: - description: Tags - type: string - type: array - required: - - name ListQueryResponse: properties: count: @@ -678,91 +606,6 @@ components: type: array required: - name - SecurityPolicyGlobalPrefixScreenV2N1: - properties: - description: - description: 'The description of the security policy global prefix. - - ' - id: - description: 'The ID of the security policy global prefix. - - ' - type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the priority policy global prefix. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'Lists the IPv6 addresses of the security policy global prefix. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - name: - description: 'The name of the security policy global prefix. - - ' - 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. \n" - items: - description: Tags - type: string - type: array - required: - - name - SecurityPolicyGlobalPrefixV2N1: - properties: - description: - description: 'The description of the security policy global prefix. - - ' - id: - description: 'The ID of the security policy global prefix. - - ' - type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the priority policy global prefix. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'Lists the IPv6 addresses of the security policy global prefix. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - name: - description: 'The name of the security policy global prefix. - - ' - 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. - - ' - items: - description: Tags - type: string - type: array - required: - - name SecurityPolicyRule: properties: action: @@ -1258,7 +1101,7 @@ components: type: array required: - name - SecurityPolicyV2N1RuleQueryFilter: + SecurityPolicyV2Rule: properties: action: description: "The action taken for traffic matching this rule. It determine\ @@ -1266,7 +1109,8 @@ components: \ zone should respond. \n" type: string app_def_ids: - description: 'The security policy rule application ID. + description: 'The number of app definition IDs that have applied security + policy rules. Maximum 16 applications can be specified in a rule. ' items: @@ -1294,7 +1138,8 @@ components: type: string type: array enabled: - description: "The security policy rule, if enabled. \n" + description: "The security policy rules based on rules that are enabled.\ + \ \n" type: boolean id: description: 'The security policy rule ID. @@ -1308,7 +1153,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 @@ -1337,16 +1182,11 @@ components: description: Tags type: string type: array - user_or_group: - $ref: '#/components/schemas/UserGroup' - description: 'The details of the user or group. - - ' required: - enabled - action - name - SecurityPolicyV2N1RuleScreen: + SecurityPolicyV2RuleQueryFilter: properties: action: description: "The action taken for traffic matching this rule. It determine\ @@ -1354,7 +1194,8 @@ components: \ zone should respond. \n" type: string app_def_ids: - description: 'The security policy rule application ID. + description: 'The number of app definition IDs that have applied security + policy rules. Maximum 16 applications can be specified in a rule. ' items: @@ -1382,7 +1223,8 @@ components: type: string type: array enabled: - description: "The security policy rule, if enabled. \n" + description: "The security policy rules based on rules that are enabled.\ + \ \n" type: boolean id: description: 'The security policy rule ID. @@ -1392,11 +1234,16 @@ components: name: description: 'The name of the security policy rule. Max size = 128. + ' + type: string + policyset_id: + description: 'The policy set ID. + ' 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 @@ -1425,16 +1272,11 @@ components: description: Tags type: string type: array - user_or_group: - $ref: '#/components/schemas/UserGroup' - description: 'The details of the user or group. - - ' required: - enabled - action - name - SecurityPolicyV2Rule: + SecurityPolicyV2RuleScreen: properties: action: description: "The action taken for traffic matching this rule. It determine\ @@ -1507,10 +1349,9 @@ components: type: string type: array tags: - description: 'A information field that can be added to identify the security - policy rule. Maximum 10 unique tags of length 1024 each are allowed. - - ' + description: "A information field that can be added to identify the security\ + \ policy rule. Maximum 10 unique tags of length 1024 each are allowed.\ + \ \n" items: description: Tags type: string @@ -1519,86 +1360,39 @@ components: - enabled - action - name - SecurityPolicyV2RuleQueryFilter: + SecurityPolicyV2Set: properties: - action: - 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" + clone_from: + description: "Policy sets cloned from existing policy sets. \n" type: string - app_def_ids: - description: 'The number of app definition IDs that have applied security - policy rules. Maximum 16 applications can be specified in a rule. - - ' - items: - description: App Def Ids - type: string - type: array + defaultrule_policyset: + description: "The default rule of the policy set. \n" + type: boolean description: - description: 'The description of the security policy rule. Max size = 256. - - ' - destination_prefix_ids: - 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: 'The destination zone IDs. Max list of zone IDs is 16. + description: 'The description of the security policy set. Max size = 256. ' - items: - description: Destination Zone Ids - type: string - type: array - enabled: - description: "The security policy rules based on rules that are enabled.\ - \ \n" - type: boolean id: - description: 'The security policy rule ID. + description: 'The security policy set ID. ' type: string name: - description: 'The name of the security policy rule. Max size = 128. - - ' - type: string - policyset_id: - description: 'The policy set ID. + description: 'The name of the security policy set. Max size = 128. ' type: string - 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: 'The source prefix IDs. Max list of IDs is 16. - - ' - items: - description: Source Prefix Ids - type: string - type: array - source_zone_ids: - description: 'The source zone IDs. Max list of IDs is 16. + policyrule_order: + description: 'The order for the execution of the policy rule. ' items: - description: Source Zone Ids + description: Policyrule Order type: string type: array tags: description: 'A information field that can be added to identify the security - policy rule. Maximum 10 unique tags of length 1024 each are allowed. + policy set. Maximum 10 unique tags of length 1024 each are allowed. ' items: @@ -1606,236 +1400,23 @@ components: type: string type: array required: - - enabled - - action - name - SecurityPolicyV2RuleScreen: + SecurityPolicyV2SetQuery: properties: - action: - 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: 'The number of app definition IDs that have applied security - policy rules. Maximum 16 applications can be specified in a rule. + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of security policies V2 that match the + query parameters. ' - items: - description: App Def Ids - type: string - type: array - description: - description: 'The description of the security policy rule. Max size = 256. + dest_page: + description: 'The destination page. ' - destination_prefix_ids: - 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: 'The destination zone IDs. Max list of zone IDs is 16. - - ' - items: - description: Destination Zone Ids - type: string - type: array - enabled: - description: "The security policy rules based on rules that are enabled.\ - \ \n" - type: boolean - id: - description: 'The security policy rule ID. - - ' - type: string - name: - description: 'The name of the security policy rule. Max size = 128. - - ' - type: string - 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: 'The source prefix IDs. Max list of IDs is 16. - - ' - items: - description: Source Prefix Ids - type: string - type: array - source_zone_ids: - description: 'The source zone IDs. Max list of IDs is 16. - - ' - items: - description: Source Zone Ids - type: string - type: array - tags: - description: "A information field that can be added to identify the security\ - \ policy rule. Maximum 10 unique tags of length 1024 each are allowed.\ - \ \n" - items: - description: Tags - type: string - type: array - required: - - enabled - - action - - name - SecurityPolicyV2RuleV2N1: - properties: - action: - 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: 'The security policy rule application ID. - - ' - items: - description: App Def Ids - type: string - type: array - description: - description: 'The description of the security policy rule. Max size = 256. - - ' - destination_prefix_ids: - 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: 'The destination zone IDs. Max list of zone IDs is 16. - - ' - items: - description: Destination Zone Ids - type: string - type: array - enabled: - description: "The security policy rule, if enabled. \n" - type: boolean - id: - description: 'The security policy rule ID. - - ' - type: string - name: - description: 'The name of the security policy rule. Max size = 128. - - ' - type: string - 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: 'The source prefix IDs. Max list of IDs is 16. - - ' - items: - description: Source Prefix Ids - type: string - type: array - source_zone_ids: - description: 'The source zone IDs. Max list of IDs is 16. - - ' - items: - description: Source Zone Ids - type: string - type: array - tags: - 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: "The details of the user or group. \n" - required: - - enabled - - action - - name - SecurityPolicyV2Set: - properties: - clone_from: - description: "Policy sets cloned from existing policy sets. \n" - type: string - defaultrule_policyset: - description: "The default rule of the policy set. \n" - type: boolean - description: - description: 'The description of the security policy set. Max size = 256. - - ' - id: - description: 'The security policy set ID. - - ' - type: string - name: - description: 'The name of the security policy set. Max size = 128. - - ' - type: string - policyrule_order: - description: 'The order for the execution of the policy rule. - - ' - items: - description: Policyrule Order - type: string - type: array - tags: - description: 'A information field that can be added to identify the security - policy set. Maximum 10 unique tags of length 1024 each are allowed. - - ' - items: - description: Tags - type: string - type: array - required: - - name - SecurityPolicyV2SetQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of security policies V2 that match the - query parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number of security policies V2 deleted for a time frame. + format: int32 + type: integer + getDeleted: + description: 'The number of security policies V2 deleted for a time frame. ' type: boolean @@ -2387,192 +1968,84 @@ components: description: Tags type: string type: array - SitePrefixAssociationQueryFilterV2N1: + SiteSecurityPolicyV2PrefixAssociation: properties: id: - description: 'The ID of the site prefix. + description: 'The ID of the security policy v2 prefix association. ' type: string ipv4_prefixes: - description: 'The individual IP address. + description: 'Lists the IPv4 addresses of the security policy v2 prefix + association. ' items: description: Ipv4 Prefixes type: string type: array - ipv6_prefixes: - description: 'Lists the IPv6 address. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array prefix_id: description: "The IP Prefix ID that associates with a site. \n" type: string - site_id: - description: 'The site ID binding the prefix. - - ' - type: string tags: - description: 'A information field that can be added to identify the site - prefix. Maximum 10 unique tags of length 1024 each are allowed. + description: 'An information field that can be added to identify the security + policy v2 prefix association. Maximum 10 unique tags of length 1024 each + are allowed. ' items: description: Tags type: string type: array - SiteSecurityPolicyV2N1PrefixAssociation: + SiteSecurityPolicyV2PrefixAssociationScreen: properties: id: - description: 'The ID of the site prefix. + description: 'The ID of the security policy v2 prefix association. ' type: string ipv4_prefixes: - description: 'The individual IP address. + description: 'Lists the IPv4 addresses of the security policy v2 prefix + association. ' items: description: Ipv4 Prefixes type: string type: array - ipv6_prefixes: - description: 'Lists the IPv6 address. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array prefix_id: description: "The IP Prefix ID that associates with a site. \n" type: string tags: - description: 'A information field that can be added to identify the site - prefix. Maximum 10 unique tags of length 1024 each are allowed. + description: 'An information field that can be added to identify the security + policy v2 prefix association. Maximum 10 unique tags of length 1024 each + are allowed. ' items: description: Tags type: string type: array - SiteSecurityPolicyV2N1PrefixAssociationScreen: + SiteSecurityZoneNetworkAssociationQueryFilter: properties: id: - description: 'The ID of the site prefix. + description: 'The ID of the security zone. ' type: string - ipv4_prefixes: - description: 'The individual IP address. + networks: + description: 'The details of the network and network type. ' items: - description: Ipv4 Prefixes - type: string + $ref: '#/components/schemas/SiteContext' type: array - ipv6_prefixes: - description: 'Lists the IPv6 address. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - prefix_id: - description: "The IP Prefix ID that associates with a site. \n" - type: string - tags: - description: "A information field that can be added to identify the site\ - \ prefix. Maximum 10 unique tags of length 1024 each are allowed. \n" - items: - description: Tags - type: string - type: array - SiteSecurityPolicyV2PrefixAssociation: - properties: - id: - description: 'The ID of the security policy v2 prefix association. - - ' - type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the security policy v2 prefix - association. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - prefix_id: - description: "The IP Prefix ID that associates with a site. \n" - type: string - tags: - description: 'An information field that can be added to identify the security - policy v2 prefix association. Maximum 10 unique tags of length 1024 each - are allowed. - - ' - items: - description: Tags - type: string - type: array - SiteSecurityPolicyV2PrefixAssociationScreen: - properties: - id: - description: 'The ID of the security policy v2 prefix association. - - ' - type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the security policy v2 prefix - association. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - prefix_id: - description: "The IP Prefix ID that associates with a site. \n" - type: string - tags: - description: 'An information field that can be added to identify the security - policy v2 prefix association. Maximum 10 unique tags of length 1024 each - are allowed. - - ' - items: - description: Tags - type: string - type: array - SiteSecurityZoneNetworkAssociationQueryFilter: - properties: - id: - description: 'The ID of the security zone. - - ' - type: string - networks: - description: 'The details of the network and network type. - - ' - items: - $ref: '#/components/schemas/SiteContext' - type: array - site_id: - description: "The site ID configured for the element security zone. \ - \ \n" - type: string - zone_id: - description: 'The ID of the security zone. + site_id: + description: "The site ID configured for the element security zone. \ + \ \n" + type: string + zone_id: + description: 'The ID of the security zone. ' type: string @@ -2580,24 +2053,6 @@ components: - site_id - networks - zone_id - UserGroup: - properties: - user_group_ids: - description: 'The user group IDs. - - ' - items: - description: User Group Ids - type: string - type: array - user_ids: - description: 'The user IDs. - - ' - items: - description: User Ids - type: string - type: array info: contact: {} description: List of APIs used to manage your security policy rules that include @@ -5721,745 +5176,6 @@ paths: summary: Query Security Zone for NB API (v2.0) tags: - Security Policy - /v2.1/api/tenants/{tenant_id}/ngfwsecuritypolicyglobalprefixes: - get: - description: List all the security policy V2 global prefixes for a tenant. - operationId: get-v2.1-api-tenants-tenant_id-ngfwsecuritypolicyglobalprefixes - 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/SecurityPolicyGlobalPrefixV2N1' - type: array - type: object - description: Successful Operation - summary: Get Security Policy Global Prefixes (v2.1) - tags: - - Security Policy - post: - description: Create a security policy V2 global prefix. - operationId: post-v2.1-api-tenants-tenant_id-ngfwsecuritypolicyglobalprefixes - 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/SecurityPolicyGlobalPrefixScreenV2N1' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyGlobalPrefixV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_INPUT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: INVALID_PREFIX - - code: NAME_REQD - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_TAG - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Security Policy Global Prefix (v2.1) - tags: - - Security Policy - /v2.1/api/tenants/{tenant_id}/ngfwsecuritypolicyglobalprefixes/query: - post: - description: Query the security policy V2 global prefixes of a tenant. - operationId: post-v2.1-api-tenants-tenant_id-ngfwsecuritypolicyglobalprefixes-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/GlobalPrefixQueryFilterV2N1' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/GlobalPrefixQueryFilter' - type: array - type: object - description: Successful Operation - summary: Query Security Policy Global Prefixes (v2.1) - tags: - - Security Policy - /v2.1/api/tenants/{tenant_id}/ngfwsecuritypolicyglobalprefixes/{prefix_id}: - delete: - description: Delete a security policy V2 global prefix by the tenant ID and - the prefix ID. - operationId: delete-v2.1-api-tenants-tenant_id-ngfwsecuritypolicyglobalprefixes-prefix_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: ID of the security policy global prefix. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyGlobalPrefixV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: PREFIX_IS_USED_BY_RULE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Security Policy Global Prefix (v2.1) - tags: - - Security Policy - get: - description: List a security policy V2 global prefix by the tenant ID and the - prefix ID. - operationId: get-v2.1-api-tenants-tenant_id-ngfwsecuritypolicyglobalprefixes-prefix_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: ID of the security policy global prefix. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyGlobalPrefixV2N1' - description: Successful Operation - summary: Get Security Policy Global Prefix (v2.1) - tags: - - Security Policy - put: - description: Update a security policy V2 global prefix by the tenant ID and - the prefix ID. - operationId: put-v2.1-api-tenants-tenant_id-ngfwsecuritypolicyglobalprefixes-prefix_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: ID of the security policy global prefix. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyGlobalPrefixScreenV2N1' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyGlobalPrefixV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_INPUT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_PREFIX - - code: NAME_REQD - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_TAG - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Security Policy Global Prefix (v2.1) - tags: - - Security Policy - /v2.1/api/tenants/{tenant_id}/ngfwsecuritypolicylocalprefixes/query: - post: - description: Query the security policy v2 local prefix site associations of - a tenant. - operationId: post-v2.1-api-tenants-tenant_id-ngfwsecuritypolicylocalprefixes-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/SitePrefixAssociationQuery' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SitePrefixAssociationQueryFilterV2N1' - type: array - type: object - description: Successful Operation - summary: Query Security Policy Local Prefix Site Associations (v2.1) - tags: - - Security Policy - /v2.1/api/tenants/{tenant_id}/ngfwsecuritypolicyrules/query: - post: - description: Query the security policy v2 rules of a tenant. - operationId: post-v2.1-api-tenants-tenant_id-ngfwsecuritypolicyrules-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/SecurityPolicyV2N1RuleQueryFilter' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SecurityPolicyV2N1RuleQueryFilter' - type: array - type: object - description: Successful Operation - summary: Query Security Policy Rules (v2.1) - tags: - - Security Policy - /v2.1/api/tenants/{tenant_id}/ngfwsecuritypolicysets/{policy_set_id}/ngfwsecuritypolicyrules: - get: - description: List all the security policy V2 rules under a policy set. - operationId: get-v2.1-api-tenants-tenant_id-ngfwsecuritypolicysets-policy_set_id-ngfwsecuritypolicyrules - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: ID of the security policy v2 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' - - properties: - items: - items: - $ref: '#/components/schemas/SecurityPolicyV2RuleV2N1' - type: array - type: object - description: Successful Operation - summary: Get Security Policy Rules under Policy Set (v2.1) - tags: - - Security Policy - post: - description: Create a security policy V2 rule under a policy set. - operationId: post-v2.1-api-tenants-tenant_id-ngfwsecuritypolicysets-policy_set_id-ngfwsecuritypolicyrules - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: ID of the security policy v2 set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyV2N1RuleScreen' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyV2RuleV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_INPUT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Security Policy Rules under Policy Set (v2.1) - tags: - - Security Policy - /v2.1/api/tenants/{tenant_id}/ngfwsecuritypolicysets/{policy_set_id}/ngfwsecuritypolicyrules/{policy_rule_id}: - delete: - description: Delete an existing security policy V2 rule under a policy set. - operationId: delete-v2.1-api-tenants-tenant_id-ngfwsecuritypolicysets-policy_set_id-ngfwsecuritypolicyrules-policy_rule_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: ID of the security policy v2 set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: ID of the security policy v2 rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyV2RuleV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: POLICYRULE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Security Policy Rules under Policy Set (v2.1) - tags: - - Security Policy - get: - description: List an existing security policy V2 rule under a policy set. - operationId: get-v2.1-api-tenants-tenant_id-ngfwsecuritypolicysets-policy_set_id-ngfwsecuritypolicyrules-policy_rule_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: ID of the security policy v2 set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: ID of the security policy v2 rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyV2RuleV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: POLICYRULE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Security Policy Rules under Policy Set (v2.1) - tags: - - Security Policy - put: - description: Update an existing security policy V2 rule under a policy set. - operationId: put-v2.1-api-tenants-tenant_id-ngfwsecuritypolicysets-policy_set_id-ngfwsecuritypolicyrules-policy_rule_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: ID of the security policy v2 set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: ID of the security policy v2 rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyV2N1RuleScreen' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyV2RuleV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_INPUT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Security Policy Rules under Policy Set (v2.1) - tags: - - Security Policy - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/ngfwsecuritypolicylocalprefixes: - get: - description: List all the security policy v2 local prefix site associations - for a site. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-ngfwsecuritypolicylocalprefixes - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - 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/SiteSecurityPolicyV2N1PrefixAssociation' - type: array - type: object - description: Successful Operation - summary: Get Security Policy Local Prefix Site Association (v2.1) - tags: - - Security Policy - post: - description: Create a security policy v2 local prefix site association. - operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-ngfwsecuritypolicylocalprefixes - parameters: - - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SiteSecurityPolicyV2N1PrefixAssociationScreen' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SiteSecurityPolicyV2N1PrefixAssociation' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_INPUT - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Security Policy Local Prefix Site Association (v2.1) - tags: - - Security Policy - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/ngfwsecuritypolicylocalprefixes/{prefix_id}: - delete: - description: Delete an existing security policy v2 local prefix site association. - operationId: delete-v2.1-api-tenants-tenant_id-sites-site_id-ngfwsecuritypolicylocalprefixes-prefix_id - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The Prefix ID that associates with a site. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SiteSecurityPolicyV2N1PrefixAssociation' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Security Policy Local Prefix Site Association (v2.1) - tags: - - Security Policy - get: - description: List an existing security policy v2 local prefix assocation by - its ID. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-ngfwsecuritypolicylocalprefixes-prefix_id - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: The Prefix ID that associates with a site. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SiteSecurityPolicyV2N1PrefixAssociation' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Security Policy Local Prefix Site Association (v2.1) - tags: - - Security Policy - put: - description: Update an existing security policy v2 local prefix site association. - operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-ngfwsecuritypolicylocalprefixes-prefix_id - parameters: - - 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 Prefix ID that associates with a site. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SiteSecurityPolicyV2N1PrefixAssociationScreen' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SiteSecurityPolicyV2N1PrefixAssociation' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_INPUT - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Security Policy Local Prefix Site Association (v2.1) - tags: - - Security Policy servers: - url: https://api.us.cloudgenix.com tags: diff --git a/openapi-specs/sdwan/legacy/Service&DCGroups.yaml b/openapi-specs/sdwan/legacy/Service&DCGroups.yaml index f2613e506..3480aec19 100644 --- a/openapi-specs/sdwan/legacy/Service&DCGroups.yaml +++ b/openapi-specs/sdwan/legacy/Service&DCGroups.yaml @@ -34,21 +34,9 @@ components: 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: @@ -58,28 +46,6 @@ components: - 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 Error: properties: _error: @@ -237,15 +203,37 @@ components: ' format: float type: number + SEPLivelinessProbe: + properties: + http: + description: 'The values for probing interval, failure count, HTTP status + codes, and URL. + + ' + items: + $ref: '#/components/schemas/HttpProbe' + type: array + icmp_ping: + description: 'The values for probing interval, failure count, and IP address. + + ' + items: + $ref: '#/components/schemas/IcmpPingProbe' + type: array SEPLivelinessProbeV2N2: properties: http: - description: 'Http: Valid ' + description: 'The values for probing interval, failure count, HTTP status + codes, and URL. + + ' items: $ref: '#/components/schemas/HttpProbe' type: array icmp_ping: - description: 'Icmp Ping: Valid ' + description: 'The values for probing interval, failure count, and IP address. + + ' items: $ref: '#/components/schemas/IcmpPingProbe' type: array @@ -506,7 +494,216 @@ components: required: - service_bindings - name - ServiceEndpointV2N2: + ServiceEndpoint: + properties: + admin_up: + description: 'All data center sites are automatically added when Admin Up + is selected, which means that it can accept traffic per network policy. + + ' + type: boolean + description: + description: 'The description of the service endpoint. Max size = 256. + + ' + id: + description: 'The ID of the service endpoint. + + ' + type: string + name: + description: 'The name of the service endpoint. Max size = 128. + + ' + type: string + site_id: + description: "The site ID. \n" + type: string + tags: + description: 'A information field that can be added to identify the service + endpoint. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The network service type. + + ' + enum: + - CG_TRANSIT + - NON_CG_TRANSIT + - SASE + type: string + required: + - admin_up + - type + - name + ServiceEndpointQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of service endpoint that match the query + parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of service endpoint deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the service endpoint for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "Lists the service endpoint 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 + ServiceEndpointQueryFilter: + properties: + admin_up: + description: 'All data center sites are automatically added when Admin Up + is selected, which means that it can accept traffic per network policy. + + ' + type: boolean + description: + description: 'The description of the service endpoint. Max size = 256. + + ' + id: + description: "The ID of the service endpoint.\t\n" + type: string + name: + description: 'The name of the service endpoint. Max size = 128. + + ' + type: string + site_id: + description: Site Id + type: string + tags: + description: 'A information field that can be added to identify the service + endpoint. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The network service type. + + ' + enum: + - CG_TRANSIT + - NON_CG_TRANSIT + - SASE + type: string + required: + - admin_up + - type + - name + ServiceEndpointScreen: + properties: + admin_up: + description: 'All data center sites are automatically added when Admin Up + is selected, which means that it can accept traffic per network policy. + + ' + type: boolean + description: + description: 'The description of the service endpoint. Max size = 256. + + ' + id: + description: 'The ID of the service endpoint. + + ' + type: string + name: + description: 'The name of the service endpoint. Max size = 128. + + ' + type: string + site_id: + description: "The site ID. \n" + type: string + tags: + description: 'A information field that can be added to identify the service + endpoint. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The network service type. + + ' + enum: + - CG_TRANSIT + - NON_CG_TRANSIT + - SASE + type: string + required: + - admin_up + - type + - name + ServiceEndpointV2N1: properties: address: $ref: '#/components/schemas/Address' @@ -537,7 +734,7 @@ components: ' type: string liveliness_probe: - $ref: '#/components/schemas/SEPLivelinessProbeV2N2' + $ref: '#/components/schemas/SEPLivelinessProbe' description: 'The information on liveliness probing. ' @@ -581,7 +778,7 @@ components: - admin_up - type - name - ServiceEndpointV2N3: + ServiceEndpointV2N2: properties: address: $ref: '#/components/schemas/Address' @@ -626,11 +823,6 @@ components: ' type: string - sase_properties: - $ref: '#/components/schemas/SaseServiceEndpointProperties' - description: 'The sase service endpoint properties. - - ' service_link_peers: $ref: '#/components/schemas/ServiceLinkPeers' description: 'The value of the hostname and IP addresses. @@ -661,16 +853,96 @@ components: - admin_up - type - name - ServiceLabel: - description: - description: 'The description of the service label. Max size = 256. - - ' + ServiceEndpointV2N3: properties: - description: - description: 'Description: Size(max = 256, error = DESCRIPTION_SIZE_EXCEEDED: - Description size exceeded., min = 0) Valid ' - type: string + address: + $ref: '#/components/schemas/Address' + description: 'The address of the endpoint location. + + ' + admin_up: + description: 'All data center sites are automatically added when Admin Up + is selected, which means that it can accept traffic per network policy. + If not selected, the endpoint is not used in path selection for forwarding + traffic. + + ' + type: boolean + allow_enterprise_traffic: + description: 'Explicitly allow enterprise traffic to transit through the + cloud security service. + + ' + type: boolean + description: + description: 'The description of the service endpoint. Max size = 256. + + ' + id: + description: 'The ID of the service endpoint. + + ' + type: string + liveliness_probe: + $ref: '#/components/schemas/SEPLivelinessProbeV2N2' + description: 'The information on liveliness probing. + + ' + location: + $ref: '#/components/schemas/Location' + description: 'The service endpoint label representing a specific location. + + ' + name: + description: 'The name of the service endpoint. Max size = 128. + + ' + type: string + sase_properties: + $ref: '#/components/schemas/SaseServiceEndpointProperties' + description: 'The sase service endpoint properties. + + ' + service_link_peers: + $ref: '#/components/schemas/ServiceLinkPeers' + description: 'The value of the hostname and IP addresses. + + ' + site_id: + description: "The site ID. \n" + type: string + tags: + description: 'A information field that can be added to identify the service + endpoint. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The network service type. + + ' + enum: + - CG_TRANSIT + - NON_CG_TRANSIT + - SASE + type: string + required: + - admin_up + - 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 id: description: Id type: string @@ -1020,7 +1292,265 @@ paths: - properties: items: items: - $ref: '#/components/schemas/ServiceBindingMap' + $ref: '#/components/schemas/ServiceBindingMap' + 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 Service Binding Maps (v2.0) + tags: + - Service & DC Groups + /v2.0/api/tenants/{tenant_id}/servicebindingmaps/{map_id}: + delete: + description: Delete a service binding map. + operationId: delete-v2.0-api-tenants-tenant_id-servicebindingmaps-map_id + parameters: + - description: The ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the service binding map. + in: path + name: map_id + required: true + schema: + description: Map Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceBindingMap' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Service Binding Map (v2.0) + tags: + - Service & DC Groups + get: + description: Get a service binding map. + operationId: get-v2.0-api-tenants-tenant_id-servicebindingmaps-map_id + parameters: + - description: The ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the service binding map. + in: path + name: map_id + required: true + schema: + description: Map Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceBindingMap' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + - code: SERVICEBINDINGMAP_DELETE_NOTALLOWED_SITE_EXISTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Service Binding Map (v2.0) + tags: + - Service & DC Groups + put: + description: Update a service binding map. + operationId: put-v2.0-api-tenants-tenant_id-servicebindingmaps-map_id + parameters: + - description: The ID of the tenant. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The ID of the service binding map. + in: path + name: map_id + required: true + schema: + description: Map Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceBindingMapScreen' + description: Details of the service binding maps to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceBindingMap' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + - code: SERVICEBINDINGMAP_NAME_REQD + - code: DESCRIPTION_SIZE_EXCEEDED + - code: SERVICEBINDING_NAME_EXCEEDS_LIMIT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: SERVICEBINDINGMAP_CONFIG_INVALID_SERVICELABEL + - code: SERVICEBINDINGMAP_CONFIG_INVALID_SERVICEENDPOINT + - code: SERVICEBINDINGMAP_CONFIG_SASELABEL_TOO_MANY_SERVICEENDPOINTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Service Binding Map (v2.0) + tags: + - Service & DC Groups + /v2.0/api/tenants/{tenant_id}/serviceendpoints: + get: + description: Get ServiceEndpointList + operationId: get-v2.0-api-tenants-tenant_id-serviceendpoints + parameters: + - description: 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/ServiceEndpoint' + 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 ServiceEndpointList (v2.0) + tags: + - Service & DC Groups + post: + description: Create a new Service Endpoint + operationId: post-v2.0-api-tenants-tenant_id-serviceendpoints + 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/ServiceEndpointScreen' + description: Details of the service endpoint to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceEndpoint' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + - code: SERVICEENDPOINT_NAME_REQD + - code: SERVICEENDPOINT_NAME_EXCEEDS_LIMIT + - code: DESCRIPTION_SIZE_EXCEEDED + - code: ADMIN_UP_REQD + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: UNKNOWN_SITE + - code: SERVICEENDPOINT_EXIST_WITH_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create a new Service Endpoint (v2.0) + tags: + - Service & DC Groups + /v2.0/api/tenants/{tenant_id}/serviceendpoints/query: + post: + description: Queries db for limit number of service bindings that match query + params. + operationId: post-v2.0-api-tenants-tenant_id-serviceendpoints-query + 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/ServiceEndpointQuery' + description: Query details for service endpoints + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ServiceEndpointQueryFilter' type: array type: object description: Successful Operation @@ -1034,34 +1564,35 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Service Binding Maps (v2.0) + summary: Queries db for limit number of service bindings that match query params. + (v2.0) tags: - Service & DC Groups - /v2.0/api/tenants/{tenant_id}/servicebindingmaps/{map_id}: + /v2.0/api/tenants/{tenant_id}/serviceendpoints/{service_endpoint_id}: delete: - description: Delete a service binding map. - operationId: delete-v2.0-api-tenants-tenant_id-servicebindingmaps-map_id + description: Delete a Service Endpoint + operationId: delete-v2.0-api-tenants-tenant_id-serviceendpoints-service_endpoint_id parameters: - - description: The ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the service binding map. + - description: Serviceendpoint Id in: path - name: map_id + name: service_endpoint_id required: true schema: - description: Map Id + description: Service Endpoint Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ServiceBindingMap' + $ref: '#/components/schemas/ServiceEndpoint' description: Successful Operation '400': content: @@ -1070,36 +1601,37 @@ paths: value: _error: - code: INVALID_JSON + - code: SERVICEENDPOINT_DELETE_NOTALLOWED_SERVICEBINDING_EXISTS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Service Binding Map (v2.0) + summary: Delete a Service Endpoint (v2.0) tags: - Service & DC Groups get: - description: Get a service binding map. - operationId: get-v2.0-api-tenants-tenant_id-servicebindingmaps-map_id + description: Get a ServiceEndpoint + operationId: get-v2.0-api-tenants-tenant_id-serviceendpoints-service_endpoint_id parameters: - - description: The ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the service binding map. + - description: ServiceEndpoint Id in: path - name: map_id + name: service_endpoint_id required: true schema: - description: Map Id + description: Service Endpoint Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ServiceBindingMap' + $ref: '#/components/schemas/ServiceEndpoint' description: Successful Operation '400': content: @@ -1108,43 +1640,42 @@ paths: value: _error: - code: INVALID_JSON - - code: SERVICEBINDINGMAP_DELETE_NOTALLOWED_SITE_EXISTS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Service Binding Map (v2.0) + summary: Get a ServiceEndpoint (v2.0) tags: - Service & DC Groups put: - description: Update a service binding map. - operationId: put-v2.0-api-tenants-tenant_id-servicebindingmaps-map_id + description: Update a ServiceEndpoint + operationId: put-v2.0-api-tenants-tenant_id-serviceendpoints-service_endpoint_id parameters: - - description: The ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the service binding map. + - description: ServiceEndpoint Id in: path - name: map_id + name: service_endpoint_id required: true schema: - description: Map Id + description: Service Endpoint Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ServiceBindingMapScreen' - description: Details of the service binding maps to be updated + $ref: '#/components/schemas/ServiceEndpointScreen' + description: Details of the service endpoint to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ServiceBindingMap' + $ref: '#/components/schemas/ServiceEndpoint' description: Successful Operation '400': content: @@ -1153,17 +1684,17 @@ paths: value: _error: - code: INVALID_JSON - - code: SERVICEBINDINGMAP_NAME_REQD + - code: SERVICEENDPOINT_NAME_REQD + - code: SERVICEENDPOINT_NAME_EXCEEDS_LIMIT - code: DESCRIPTION_SIZE_EXCEEDED - - code: SERVICEBINDING_NAME_EXCEEDS_LIMIT + - code: ADMIN_UP_REQD - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: SERVICEBINDINGMAP_CONFIG_INVALID_SERVICELABEL - - code: SERVICEBINDINGMAP_CONFIG_INVALID_SERVICEENDPOINT - - code: SERVICEBINDINGMAP_CONFIG_SASELABEL_TOO_MANY_SERVICEENDPOINTS + - code: UNKNOWN_SITE + - code: SERVICEENDPOINT_CONFIG_UPDATE_NOTALLOWED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Service Binding Map (v2.0) + summary: Update a ServiceEndpoint (v2.0) tags: - Service & DC Groups /v2.0/api/tenants/{tenant_id}/servicelabels: @@ -1673,6 +2204,257 @@ paths: summary: Update Service Binding Map (v2.1) tags: - Service & DC Groups + /v2.1/api/tenants/{tenant_id}/serviceendpoints: + get: + description: Get ServiceEndpointList + operationId: get-v2.1-api-tenants-tenant_id-serviceendpoints + parameters: + - description: 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/ServiceEndpointV2N1' + 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 ServiceEndpointList (v2.1) + tags: + - Service & DC Groups + post: + description: Create a new Service Endpoint + operationId: post-v2.1-api-tenants-tenant_id-serviceendpoints + 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/ServiceEndpointV2N1' + description: Service Endpoint + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceEndpointV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: UNKNOWN_SITE + - code: SERVICEENDPOINT_EXIST_WITH_SITE + - code: INVALID_JSON_EXTRA_ATTRIBUTE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create a new Service Endpoint (v2.1) + tags: + - Service & DC Groups + /v2.1/api/tenants/{tenant_id}/serviceendpoints/query: + post: + description: Queries db for limit number of service bindings that match query + params. + operationId: post-v2.1-api-tenants-tenant_id-serviceendpoints-query + 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/ServiceEndpointQuery' + description: Query details for Priority Policy set stacks + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ServiceEndpointQueryFilter' + 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: Queries db for limit number of service bindings that match query params. + (v2.1) + tags: + - Service & DC Groups + /v2.1/api/tenants/{tenant_id}/serviceendpoints/{service_endpoint_id}: + delete: + description: Delete a Service Endpoint + operationId: delete-v2.1-api-tenants-tenant_id-serviceendpoints-service_endpoint_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Serviceendpoint Id + in: path + name: service_endpoint_id + required: true + schema: + description: Service Endpoint Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceEndpointV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + - code: SERVICEENDPOINT_IS_IN_USE + - code: SERVICEENDPOINT_DELETE_NOTALLOWED_SERVICEBINDING_EXISTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete a Service Endpoint (v2.1) + tags: + - Service & DC Groups + get: + description: Get a ServiceEndpoint + operationId: get-v2.1-api-tenants-tenant_id-serviceendpoints-service_endpoint_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ServiceEndpoint Id + in: path + name: service_endpoint_id + required: true + schema: + description: Service Endpoint Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceEndpointV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get a ServiceEndpoint (v2.1) + tags: + - Service & DC Groups + put: + description: Update a ServiceEndpoint + operationId: put-v2.1-api-tenants-tenant_id-serviceendpoints-service_endpoint_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ServiceEndpoint Id + in: path + name: service_endpoint_id + required: true + schema: + description: Service Endpoint Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceEndpointV2N1' + description: Service Endpoint + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceEndpointV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: UNKNOWN_SITE + - code: SERVICEENDPOINT_CONFIG_UPDATE_NOTALLOWED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update a ServiceEndpoint (v2.1) + tags: + - Service & DC Groups /v2.1/api/tenants/{tenant_id}/servicelabels: get: description: List all the service labels. diff --git a/openapi-specs/sdwan/legacy/Services.yaml b/openapi-specs/sdwan/legacy/Services.yaml index 37cfcfd4f..4ec376905 100644 --- a/openapi-specs/sdwan/legacy/Services.yaml +++ b/openapi-specs/sdwan/legacy/Services.yaml @@ -37,6 +37,64 @@ components: ' type: string type: object + SyslogServer: + properties: + description: + description: 'The description of the syslog server. Max characters = 1024. + + ' + enabled: + description: 'The Syslog server field is enabled to enable the Syslog server. + + ' + type: boolean + id: + description: 'The ID of the Syslog server. + + ' + type: string + name: + description: 'The Syslog server name. Max characters = 128. + + ' + type: string + protocol: + description: "The protocol type (TCP, or UDP, or TLS). The default protocol\ + \ is UDP. \n" + type: string + server_ip: + description: "The Syslog server IP address. \n" + type: string + server_port: + description: 'The Syslog server port number. The default port is 514 for + TCP or UDP and 6514 for TLS. + + ' + format: int32 + type: integer + severity_level: + description: 'The Severity Level from a severity level of critical, major, + or minor. + + ' + type: string + source_interface: + description: 'The source interface for the Syslog server. If no value is + entered for this field, then the controller port is considered as the + default source interface. + + ' + type: string + tags: + description: "A information field that can be added to identify the event\ + \ multicast RP config. Maximum 10 unique tags of length 1024 each are\ + \ allowed. \n" + items: + description: Tags + type: string + type: array + required: + - name SyslogServerProfile: properties: description: @@ -313,6 +371,260 @@ info: version: Latest openapi: 3.0.0 paths: + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/syslogservers: + get: + description: Get Syslog Servers on an element + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-syslogservers + parameters: + - description: Tenant ID + 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 + 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/SyslogServer' + type: array + type: object + description: Successful Operation + summary: Get Syslog Servers on an element (v2.0) + tags: + - Services + post: + description: Create Syslog Server + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-syslogservers + parameters: + - description: Tenant ID + 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServer' + description: Details of the Syslog Server + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServer' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_BOUND + - code: SYSLOGSERVER_CONFIG_EXCEEDS_LIMIT + - code: SYSLOGSERVER_CONFIG_SERVER_IP_MISSING + - code: SYSLOGSERVER_CONFIG_INVALID_RANGE + - code: SYSLOGSERVER_CONFIG_INVALID_PROTOCOL + - code: SYSLOGSERVER_CONFIG_INVALID_SEVERITY_LEVEL + - code: SYSLOGSERVER_CONFIG_NOT_SUPPORTED + - code: SYSLOGSERVER_CONFIG_FLOW_LOGGING_NOT_SUPPORTED + - code: SYSLOGSERVER_CONFIG_REQD_SOURCE_INTERFACE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Syslog Server (v2.0) + tags: + - Services + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/syslogservers/{syslogserver_id}: + delete: + description: Delete Syslog Server + operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-syslogservers-syslogserver_id + parameters: + - description: Tenant ID + 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Config ID + in: path + name: syslogserver_id + required: true + schema: + description: Syslogserver Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServer' + description: Successful Operation + summary: Delete Syslog Server (v2.0) + tags: + - Services + get: + description: Get Syslog Server + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-syslogservers-syslogserver_id + parameters: + - description: Tenant ID + 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Config ID + in: path + name: syslogserver_id + required: true + schema: + description: Syslogserver Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServer' + description: Successful Operation + summary: Get Syslog Server (v2.0) + tags: + - Services + put: + description: Update Syslog Server + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-elements-element_id-syslogservers-syslogserver_id + parameters: + - description: Tenant ID + 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 + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: Config ID + in: path + name: syslogserver_id + required: true + schema: + description: Syslogserver Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServer' + description: Details of the Syslog Server + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServer' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: SYSLOGSERVER_CONFIG_SERVER_IP_MISSING + - code: SYSLOGSERVER_CONFIG_INVALID_RANGE + - code: SYSLOGSERVER_CONFIG_INVALID_PROTOCOL + - code: SYSLOGSERVER_CONFIG_INVALID_SEVERITY_LEVEL + - code: SYSLOGSERVER_CONFIG_FLOW_LOGGING_NOT_SUPPORTED + - code: SYSLOGSERVER_CONFIG_REQD_SOURCE_INTERFACE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Syslog Server (v2.0) + tags: + - Services /v2.0/api/tenants/{tenant_id}/syslogserverprofiles: get: description: List the syslog server profiles. diff --git a/openapi-specs/sdwan/legacy/SiteConfiguration.yaml b/openapi-specs/sdwan/legacy/SiteConfiguration.yaml index 1a8f5a481..2309fd128 100644 --- a/openapi-specs/sdwan/legacy/SiteConfiguration.yaml +++ b/openapi-specs/sdwan/legacy/SiteConfiguration.yaml @@ -46,21 +46,9 @@ components: 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: @@ -70,28 +58,42 @@ components: - avg - sum type: string - statistic: - description: 'QoS application aggregate statistics. + 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: string - unit: - description: 'The unit. + type: boolean + suppressed: + description: 'The events are suppressed. True or False. ' - type: string - AggregateData: - properties: - value: - description: 'Value of the aggregate data. + type: boolean + suppressed_info: + $ref: '#/components/schemas/SuppressedInfo' + description: 'The information on the suppressed events. ' - type: number - view: - description: 'View the aggregate date. + timestamp: + description: 'The time stamp of the event. ' - type: object + format: int64 + type: integer BulkResponse: properties: count: @@ -977,7 +979,7 @@ components: ' format: int64 type: integer - SiteQueryFilterV4N8: + SiteQueryFilter: properties: address: $ref: '#/components/schemas/Address' @@ -1001,12 +1003,10 @@ 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" + events: + description: Events items: - $ref: '#/components/schemas/ExtendedTag' + $ref: '#/components/schemas/BaseEventState' type: array id: description: 'The ID. @@ -1018,73 +1018,93 @@ components: description: 'The geographical cordinates for the site address. ' - multicast_peer_group_id: - description: 'The multicast peer group ID. + name: + description: 'The site name (Max size = 128). ' type: string - name: - description: 'The site name (Max size = 128). + policy_set_id: + description: 'The ID for the Original Network Policy Set. Can be retrieved + using policysets API. ' type: string - nat_policysetstack_id: - description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack - API. + security_policyset_id: + description: 'The ID for the Original Security Policy Set. Can be retrieved + using securitypolicysets API. ' type: string - network_policysetstack_id: - description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps API. ' type: string - policy_set_id: - description: 'The ID for the Original Network Policy Set. Can be retrieved - using policysets API. + SiteQueryFilterV4N2: + 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 - priority_policysetstack_id: - description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack - API. + 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 - security_policyset_id: - description: Security Policyset Id + id: + description: 'The ID. + + ' type: string - security_policysetstack_id: - description: 'ID for the Security Policyset Stack. Can be retrieved using - ngfwpolicysetstack API. + location: + $ref: '#/components/schemas/Location' + description: 'The geographical cordinates for the site address. + + ' + name: + description: 'The site name (Max size = 128). ' type: string - service_binding: - description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps - API. + network_policysetstack_id: + description: Network Policysetstack Id + type: string + policy_set_id: + description: 'The ID for the Original Network Policy Set. Can be retrieved + using policysets API. ' type: string - tags: - description: 'A information field that can be added to identify the site. + priority_policysetstack_id: + description: Priority Policysetstack Id + type: string + security_policyset_id: + description: 'The ID for the Original Security Policy Set. Can be retrieved + using securitypolicysets API. ' - items: - description: Tags - type: string - type: array - vrf_context_profile_id: - description: 'The VRF (Virtual Routing and Forwarding) profile ID. + type: string + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps + API. ' type: string - required: - - element_cluster_role - - admin_state - - name - SiteQueryFilterV4N9: + SiteQueryFilterV4N3: properties: address: $ref: '#/components/schemas/Address' @@ -1108,15 +1128,6 @@ 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. @@ -1127,31 +1138,17 @@ 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: '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. + description: 'The 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. @@ -1168,12 +1165,6 @@ 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: @@ -1190,16 +1181,7 @@ 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 - SiteScreenV4N8: + SiteQueryFilterV4N4: properties: address: $ref: '#/components/schemas/Address' @@ -1223,13 +1205,6 @@ 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. @@ -1240,25 +1215,17 @@ 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: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack - API. - - ' + description: Nat Policysetstack Id type: string network_policysetstack_id: - description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack - API. + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. ' type: string @@ -1275,11 +1242,8 @@ 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. + description: 'The ID for the Original Security Policy Set. Can be retrieved + using securitypolicysets API. ' type: string @@ -1297,16 +1261,7 @@ 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 - SiteScreenV4N9: + SiteQueryFilterV4N5: properties: address: $ref: '#/components/schemas/Address' @@ -1331,11 +1286,9 @@ 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. - - ' + description: 'Extended Tags: Valid ListObject(allowDuplicate = false, allowEmpty + = true, allowNull = true, listMaxSize = 10, message = INVALID_EXTENDED_TAG_SIZE_OR_DUPLICATE, + required = false) ' items: $ref: '#/components/schemas/ExtendedTag' type: array @@ -1349,11 +1302,6 @@ 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). @@ -1366,14 +1314,11 @@ components: ' type: string network_policysetstack_id: - description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack - API. + description: 'The 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. @@ -1390,12 +1335,6 @@ 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: @@ -1412,11 +1351,6 @@ 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 @@ -1472,7 +1406,7 @@ components: required: - site_id - tenant_id - SiteV4N8: + SiteV4N2: properties: address: $ref: '#/components/schemas/Address' @@ -1496,15 +1430,6 @@ 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. @@ -1515,31 +1440,20 @@ 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: '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. + description: 'The 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. + using policy sets API. ' type: string @@ -1551,13 +1465,7 @@ components: 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. + using security policy sets API. ' type: string @@ -1565,26 +1473,13 @@ components: 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 - SiteV4N9: + SiteV4N3: properties: address: $ref: '#/components/schemas/Address' @@ -1608,15 +1503,6 @@ 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. @@ -1627,31 +1513,17 @@ components: description: 'The geographical cordinates for the site address. ' - multicast_peer_group_id: - description: 'The multicast peer group ID. + name: + description: 'The site name (Max size = 128). ' type: string - name: - description: 'The site name (Max size = 128). + network_policysetstack_id: + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. ' 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. @@ -1668,12 +1540,6 @@ 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: @@ -1690,44 +1556,85 @@ 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 - SpokeCluster: + SiteV4N4: properties: - advertisement_interval: - description: "Lists the intervals in which the active device advertises\ - \ its status to the backup. \n" - format: double - type: number + 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: 'The cluster 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 id: - description: 'The ID of the site. + description: 'The ID. ' type: string + location: + $ref: '#/components/schemas/Location' + description: 'The geographical cordinates for the site address. + + ' name: - description: 'Name of the cluster. + description: 'The site name (Max size = 128). ' type: string - preempt: - description: 'Indicates if preemption is required or not. + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' + type: string + network_policysetstack_id: + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. ' - type: boolean + 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 + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps + API. + + ' + type: string tags: - description: 'Displays the details about the tags or labels applied to the - clusters. + description: 'A information field that can be added to identify the site. ' items: @@ -1735,117 +1642,93 @@ components: type: string type: array required: - - advertisement_interval - - preempt + - element_cluster_role + - admin_state - name - SpokeClusterOperations: + SiteV4N5: properties: - action: - description: "Lists the action to be performed on the cluster. \n" - enum: - - RE_ELECTION - type: string - id: - description: 'The ID of the spoke cluster. + address: + $ref: '#/components/schemas/Address' + description: 'The address of the site. ' - type: string - SpokeClusterQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of clusters that match the query parameters. + 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. ' - dest_page: - description: 'The destination page. + type: string + description: + description: 'Description for the site (Max size = 1024). ' - format: int32 - type: integer - getDeleted: - description: 'The number clusters deleted for a time frame. + element_cluster_role: + description: 'This attribute describes the type i.e. SPOKE or HUB. ' - type: boolean - group_by: - description: Group By + 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) ' items: - description: Group By - type: string + $ref: '#/components/schemas/ExtendedTag' type: array id: - description: "List the clusters 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. + description: 'The ID. ' - format: int32 - type: integer - next_query: - description: 'The limit. + type: string + location: + $ref: '#/components/schemas/Location' + description: 'The geographical cordinates for the site address. ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. + name: + description: 'The site name (Max size = 128). ' - items: - description: Retrieved Fields - type: string - type: array - retrieved_fields_mask: - description: 'List the fields to query. + type: string + nat_policysetstack_id: + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. ' - type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. + type: string + network_policysetstack_id: + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. ' - format: int64 - type: integer - SpokeClusterQueryFilter: - properties: - advertisement_interval: - description: "Lists the intervals in which the active device advertises\ - \ its status to the backup. \n" - format: double - type: number - description: - description: 'The cluster description. + type: string + policy_set_id: + description: 'The ID for the Original Network Policy Set. Can be retrieved + using policysets API. ' - id: - description: 'The ID of the site. + type: string + priority_policysetstack_id: + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. ' type: string - name: - description: 'Name of the cluster. + security_policyset_id: + description: 'The ID for the Original Security Policy Set. Can be retrieved + using securitypolicysets API. ' type: string - preempt: - description: 'Indicates if preemption is required or not. + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps + API. ' - type: boolean + type: string tags: - description: 'Displays the details about the tags or labels applied to the - clusters. + description: 'A information field that can be added to identify the site. ' items: @@ -1853,534 +1736,504 @@ components: type: string type: array required: - - advertisement_interval - - preempt + - element_cluster_role + - admin_state - name - SpokeClusterQueryFilterResponse: + SiteV4N6: properties: - advertisement_interval: - description: "List the intervals in which the active device advertises its\ - \ status to the backup. \n" - format: double - type: number - description: - description: 'The cluster description. + address: + $ref: '#/components/schemas/Address' + description: 'The address of the site. ' - id: - description: 'The ID 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 - name: - description: 'Name of the cluster. + description: + description: 'Description for the site (Max size = 1024). ' - type: string - preempt: - description: 'Indicates if preemption is required or not. + element_cluster_role: + description: 'This attribute describes the type i.e. SPOKE or HUB. ' - type: boolean - site_id: - description: Site Id type: string - tags: - description: 'Displays the details about the tags or labels applied to the - clusters. + 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: - description: Tags - type: string - type: array - SpokeClusterStatus: - properties: - cluster_members: - description: "Lists the members of the spoke cluster. \n" - items: - $ref: '#/components/schemas/ClusterMember' + $ref: '#/components/schemas/ExtendedTag' type: array id: - description: 'The ID of the spoke cluster. - - ' - type: string - switch_over_events: - description: 'List the spoke cluster switch over event history. + description: 'The ID. ' - items: - $ref: '#/components/schemas/SwitchOverEvent' - type: array - SwitchOverEvent: - properties: - active: - description: Active - type: boolean - adjustments: - description: Adjustments - items: - $ref: '#/components/schemas/Adjustment' - type: array - cluster_events: - description: Cluster Events - items: - $ref: '#/components/schemas/ClusterEvent' - type: array - effective_priority: - description: Effective Priority - format: int32 - type: integer - element_id: - description: Element Id type: string - peer_connected: - description: Peer Connected - type: boolean - switch_over_time: - description: Switch Over Time - format: int64 - type: integer - ThresholdConfig: - properties: - critical_alarm: - description: Critical Alarm - format: int32 - type: integer - major_alarm: - description: Major Alarm - format: int32 - type: integer - subscription_factor: - description: Subscription Factor - format: double - type: number - VPNLinkConfiguration: - properties: - keep_alive_failure_count: - description: 'The VPN keep alive failure count (must be between 3 and 30). + location: + $ref: '#/components/schemas/Location' + description: 'The geographical cordinates for the site address. ' - type: integer - keep_alive_interval: - description: 'The VPN keep alive timeout interval (must be between 100ms-1740,000ms). + name: + description: 'The site name (Max size = 128). ' - type: integer - required: - - keep_alive_failure_count - - keep_alive_interval - WANInterfaceQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of app defs that match the query parameters. + type: string + nat_policysetstack_id: + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. ' - dest_page: - description: 'The destination page. + type: string + network_policysetstack_id: + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. ' - format: int32 - type: integer - getDeleted: - description: 'The number app definitions deleted for a time frame. + type: string + policy_set_id: + description: 'The ID for the Original Network Policy Set. Can be retrieved + using policysets API. ' - 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. + priority_policysetstack_id: + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. ' - format: int64 - type: integer - limit: - description: 'The query limit. + type: string + security_policyset_id: + description: 'The ID for the Original Security Policy Set. Can be retrieved + using securitypolicysets API. ' - format: int32 - type: integer - next_query: - description: 'The limit. + type: string + security_policysetstack_id: + description: Security Policysetstack Id + type: string + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps + API. ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. + type: string + tags: + description: 'A information field that can be added to identify the site. ' items: - description: Retrieved Fields + description: Tags type: string type: array - retrieved_fields_mask: - description: 'List the fields to query. + required: + - element_cluster_role + - admin_state + - name + SiteV4N7: + properties: + address: + $ref: '#/components/schemas/Address' + description: 'The address of the site. ' - type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. + 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 - WANInterfaceQueryFilterV2N7: - properties: - bfd_mode: - description: 'Bfd Mode: ValidateEnum(enumClass = classOf[BfdMode], WAN_CONFIG_INVALID_BFD_MODE, - nullAllowed = false) ' - enum: - - aggressive - - non_aggressive - type: string - bw_config_mode: - description: 'Bw Config Mode: ValidateEnum(enumClass = classOf[BWConfigMode], - message = INVALID_BANDWIDTH_CONFIG_MODE, nullAllowed = false) ' - enum: - - auto - - manual - - manual_bwm_disabled type: string - bwc_enabled: - description: Bwc Enabled - 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) ' - type: integer description: - description: 'Description: Size(max = 256, WANINTERFACE_CONFIG_DESCRIPTION_EXCEEDS_LIMIT, - min = 0) ' + 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: Id + description: 'The ID. + + ' type: string - label_id: - description: 'Label Id: NotEmpty(message = WAN_INTERFACE_INVALID_LABEL) ' + 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 - link_bw_down: - description: 'Link Bw Down: JsonIgnore(value = true) ' - format: double - type: number - link_bw_up: - description: 'Link Bw Up: JsonIgnore(value = true) ' - format: double - type: number - lqm_config: - $ref: '#/components/schemas/LQMConfig' - description: 'Lqm Config: Valid ' - lqm_enabled: - description: Lqm Enabled - type: boolean name: - description: 'Name: Size(max = 128, WANINTERFACE_CONFIG_NAME_EXCEEDS_LIMIT, - min = 0) ' + description: 'The site name (Max size = 128). + + ' type: string - network_id: - description: 'Network Id: NotEmpty(message = NETWORK_ID_REQD) ' + nat_policysetstack_id: + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. + + ' type: string - site_id: - description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) - NotNull ' + network_policysetstack_id: + description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack + API. + + ' 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) ' - items: - description: Tags - type: string - type: array - type: - description: Type - enum: - - PUBLIC_WAN - - PRIVATE_WAN - type: string - use_for_application_reachability_probes: - description: 'Use For Application Reachability Probes: Valid ' - type: boolean - use_for_controller_connections: - description: 'Use For Controller Connections: Valid ' - type: boolean - use_lqm_for_non_hub_paths: - description: Use Lqm For Non Hub Paths - type: boolean - vpnlink_configuration: - $ref: '#/components/schemas/VPNLinkConfiguration' - description: 'Vpnlink Configuration: Valid Nullable ' - required: - - site_id - - label_id - - bfd_mode - - bw_config_mode - - network_id - WANInterfaceScreenV2N6: - properties: - bfd_mode: - 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. + policy_set_id: + description: 'The ID for the Original Network Policy Set. Can be retrieved + using policysets API. ' - enum: - - aggressive - - non_aggressive type: string - bw_config_mode: - description: 'The bandwidth config mode. + priority_policysetstack_id: + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. ' - enum: - - auto - - manual - - manual_bwm_disabled type: string - bwc_enabled: - description: Bwc Enabled - type: boolean - cost: - description: 'Cost value for the site WAN interface should be within range - 0-1024. - - ' - type: integer - description: - description: 'The description of the WAN interface config (size max = 256). - - ' - id: - description: 'The ID. + security_policyset_id: + description: 'The ID for the Original Security Policy Set. Can be retrieved + using securitypolicysets API. ' type: string - label_id: - description: 'The WAN interface label or Circuit label ID. This can be retrieved - using the waninterfacelabels API. + security_policysetstack_id: + description: 'ID for the Security Policyset Stack. Can be retrieved using + ngfwpolicysetstack API. ' type: string - link_bw_down: - description: 'The circuit downstream capacity in MB. + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps + API. ' - format: double - type: number - link_bw_up: - description: 'The circuit upstream capacity in MB. + type: string + tags: + description: 'A information field that can be added to identify the site. ' + items: + description: Tags + type: string + type: array + required: + - element_cluster_role + - admin_state + - name + SpokeCluster: + properties: + advertisement_interval: + description: "Lists the intervals in which the active device advertises\ + \ its status to the backup. \n" format: double type: number - lqm_config: - $ref: '#/components/schemas/LQMConfig' - description: 'The link quality monitoring parameters. + description: + description: 'The cluster description. ' - lqm_enabled: - description: 'The link quality monitoring parameters. + id: + description: 'The ID of the site. ' - type: boolean + type: string name: - description: 'The name of the WAN interface config (size max = 128). + description: 'Name of the cluster. ' type: string - network_id: - description: 'The network ID. + preempt: + description: 'Indicates if preemption is required or not. ' - type: string + type: boolean tags: - description: 'An information field that can be added to identify the application. - Maximum 10 Unique tags of length 1024 each are allowed. + description: 'Displays the details about the tags or labels applied to the + clusters. ' items: description: Tags type: string type: array - type: - description: 'Type of WAN. - - ' + required: + - advertisement_interval + - preempt + - name + SpokeClusterOperations: + properties: + action: + description: "Lists the action to be performed on the cluster. \n" enum: - - PUBLIC_WAN - - PRIVATE_WAN + - RE_ELECTION type: string - use_for_application_reachability_probes: - description: 'Indicates if the use for application reachability probe is - selected. + id: + description: 'The ID of the spoke cluster. ' - type: boolean - use_for_controller_connections: - description: 'Indicates if the use for controller connections is selected. + type: string + SpokeClusterQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of clusters that match the query parameters. ' - type: boolean - vpnlink_configuration: - $ref: '#/components/schemas/VPNLinkConfiguration' - description: 'The configuration of the VPN link. + dest_page: + description: 'The destination page. ' - required: - - label_id - - bfd_mode - - bw_config_mode - - network_id - WANInterfaceScreenV2N7: - properties: - bfd_mode: - 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. + format: int32 + type: integer + getDeleted: + description: 'The number clusters deleted for a time frame. ' - enum: - - aggressive - - non_aggressive + type: boolean + group_by: + description: Group By + items: + description: Group By + type: string + type: array + id: + description: "List the clusters by ID. \n" type: string - bw_config_mode: - description: 'The bandwidth config mode. + last_query_ts: + description: 'Return the ID of a specified query in the current session. ' - enum: - - auto - - manual - - manual_bwm_disabled - type: string - bwc_enabled: - description: Bwc Enabled - type: boolean - cost: - description: 'Cost value for the site WAN interface should be within range - 0-1024. + format: int64 + type: integer + limit: + description: 'The query limit. ' + format: int32 type: integer - description: - description: 'The description of the WAN interface config (size max = 256). + next_query: + description: 'The limit. ' - id: - description: 'The ID. + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. ' - type: string - label_id: - description: 'The WAN interface label or Circuit label ID. This can be retrieved - using the waninterfacelabels API. + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. ' - type: string - link_bw_down: - description: 'The circuit downstream capacity in MB. + type: boolean + sort_params: + type: object + total_count: + description: 'The total number of query parameters. ' + format: int64 + type: integer + SpokeClusterQueryFilter: + properties: + advertisement_interval: + description: "Lists the intervals in which the active device advertises\ + \ its status to the backup. \n" format: double type: number - link_bw_up: - description: 'The circuit upstream capacity in MB. + description: + description: 'The cluster description. ' - format: double - type: number - lqm_config: - $ref: '#/components/schemas/LQMConfig' - description: 'The link quality monitoring parameters. + id: + description: 'The ID of the site. ' - lqm_enabled: - description: 'The link quality monitoring parameters. - - ' - type: boolean + type: string name: - description: 'The name of the WAN interface config (size max = 128). + description: 'Name of the cluster. ' type: string - network_id: - description: 'The network ID. + preempt: + description: 'Indicates if preemption is required or not. ' - type: string + type: boolean tags: - description: 'An information field that can be added to identify the application. - Maximum 10 Unique tags of length 1024 each are allowed. + description: 'Displays the details about the tags or labels applied to the + clusters. ' items: description: Tags type: string type: array - type: - description: 'Type of WAN. + required: + - advertisement_interval + - preempt + - name + SpokeClusterQueryFilterResponse: + properties: + advertisement_interval: + description: "List the intervals in which the active device advertises its\ + \ status to the backup. \n" + format: double + type: number + description: + description: 'The cluster description. ' - enum: - - PUBLIC_WAN - - PRIVATE_WAN - type: string - use_for_application_reachability_probes: - description: 'Indicates if the use for application reachability probe is - selected. + id: + description: 'The ID of the site. ' - type: boolean - use_for_controller_connections: - description: 'Indicates if the use for controller connections is selected. + type: string + name: + description: 'Name of the cluster. ' - type: boolean - use_lqm_for_non_hub_paths: - description: 'Indicates if the use for lqm for non hub paths is enabled. + type: string + preempt: + description: 'Indicates if preemption is required or not. ' type: boolean - vpnlink_configuration: - $ref: '#/components/schemas/VPNLinkConfiguration' - description: 'The configuration of the VPN link. + site_id: + description: Site Id + type: string + tags: + description: 'Displays the details about the tags or labels applied to the + clusters. ' - required: - - label_id - - bfd_mode - - bw_config_mode - - network_id - WANInterfaceState: + items: + description: Tags + type: string + type: array + SpokeClusterStatus: properties: + cluster_members: + description: "Lists the members of the spoke cluster. \n" + items: + $ref: '#/components/schemas/ClusterMember' + type: array id: - description: 'The ID of the WAN interface. + description: 'The ID of the spoke cluster. ' type: string - operational_state: - description: 'The operational state of the site WAN interface. + switch_over_events: + description: 'List the spoke cluster switch over event history. + + ' + items: + $ref: '#/components/schemas/SwitchOverEvent' + type: array + 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 + SwitchOverEvent: + properties: + active: + description: Active type: boolean - WANInterfaceV2N6: + adjustments: + description: Adjustments + items: + $ref: '#/components/schemas/Adjustment' + type: array + cluster_events: + description: Cluster Events + items: + $ref: '#/components/schemas/ClusterEvent' + type: array + effective_priority: + description: Effective Priority + format: int32 + type: integer + element_id: + description: Element Id + type: string + peer_connected: + description: Peer Connected + type: boolean + switch_over_time: + description: Switch Over Time + format: int64 + type: integer + ThresholdConfig: + properties: + critical_alarm: + description: Critical Alarm + format: int32 + type: integer + major_alarm: + description: Major Alarm + format: int32 + type: integer + subscription_factor: + description: Subscription Factor + format: double + type: number + 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 + WANInterface: properties: bfd_mode: description: 'Allowed values: aggressive - For fast failure detection of @@ -2405,14 +2258,8 @@ components: bwc_enabled: description: Bwc Enabled type: boolean - cost: - description: 'Cost value for the site WAN interface should be within range - 0-1024. - - ' - type: integer description: - description: 'The description of the WAN interface config (size max = 256). + description: 'The description of the WAN interface config. ' id: @@ -2438,18 +2285,13 @@ components: ' format: double type: number - lqm_config: - $ref: '#/components/schemas/LQMConfig' - description: 'The link quality monitoring parameters. - - ' lqm_enabled: description: 'The link quality monitoring parameters. ' type: boolean name: - description: 'The name of the WAN interface config (size max = 128). + description: 'The name of the WAN interface config. ' type: string @@ -2458,89 +2300,211 @@ components: ' type: string - tags: - description: 'An information field that can be added to identify the application. - Maximum 10 Unique tags of length 1024 each are allowed. - - ' - items: - description: Tags - type: string - type: array - type: - description: 'Type of WAN. - - ' - enum: - - PUBLIC_WAN - - PRIVATE_WAN - type: string - use_for_application_reachability_probes: - description: 'Indicates if the use for application reachability probe is - selected. - - ' - type: boolean - use_for_controller_connections: - description: "Indicates if the use for controller connections is selected.\ - \ \n" - type: boolean - vpnlink_configuration: - $ref: '#/components/schemas/VPNLinkConfiguration' - description: 'The configuration of the VPN link. - - ' required: - label_id - bfd_mode - bw_config_mode - network_id - WANInterfaceV2N7: + WANInterfaceQuery: properties: - bfd_mode: - 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: 'The bandwidth config mode. + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of app defs that match the query parameters. ' - enum: - - auto - - manual - - manual_bwm_disabled - type: string - bwc_enabled: - description: Bwc Enabled - type: boolean - cost: - description: 'Cost value for the site WAN interface should be within range - 0-1024. + dest_page: + description: 'The destination page. ' + format: int32 type: integer - description: - description: 'The description of the WAN interface config (size max = 256). + 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: 'The 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. ' - type: string - label_id: - description: 'The WAN interface label or Circuit label ID. This can be retrieved - using the waninterfacelabels API. + format: int64 + type: integer + limit: + description: 'The query limit. ' - type: string + 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 + WANInterfaceQueryFilterV2N7: + properties: + bfd_mode: + description: 'Bfd Mode: ValidateEnum(enumClass = classOf[BfdMode], WAN_CONFIG_INVALID_BFD_MODE, + nullAllowed = false) ' + enum: + - aggressive + - non_aggressive + type: string + bw_config_mode: + description: 'Bw Config Mode: ValidateEnum(enumClass = classOf[BWConfigMode], + message = INVALID_BANDWIDTH_CONFIG_MODE, nullAllowed = false) ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + 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) ' + type: integer + description: + description: 'Description: Size(max = 256, WANINTERFACE_CONFIG_DESCRIPTION_EXCEEDS_LIMIT, + min = 0) ' + type: string + id: + description: Id + type: string + label_id: + description: 'Label Id: NotEmpty(message = WAN_INTERFACE_INVALID_LABEL) ' + type: string + link_bw_down: + description: 'Link Bw Down: JsonIgnore(value = true) ' + format: double + type: number + link_bw_up: + description: 'Link Bw Up: JsonIgnore(value = true) ' + format: double + type: number + lqm_config: + $ref: '#/components/schemas/LQMConfig' + description: 'Lqm Config: Valid ' + lqm_enabled: + description: Lqm Enabled + type: boolean + name: + description: 'Name: Size(max = 128, WANINTERFACE_CONFIG_NAME_EXCEEDS_LIMIT, + min = 0) ' + type: string + network_id: + description: 'Network Id: NotEmpty(message = NETWORK_ID_REQD) ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: Type + enum: + - PUBLIC_WAN + - PRIVATE_WAN + type: string + use_for_application_reachability_probes: + description: 'Use For Application Reachability Probes: Valid ' + type: boolean + use_for_controller_connections: + description: 'Use For Controller Connections: Valid ' + type: boolean + use_lqm_for_non_hub_paths: + description: Use Lqm For Non Hub Paths + type: boolean + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'Vpnlink Configuration: Valid Nullable ' + required: + - site_id + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceScreen: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + description: + description: 'The description of the WAN interface config. + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string link_bw_down: description: 'The circuit downstream capacity in MB. @@ -2553,11 +2517,84 @@ components: ' format: double type: number - lqm_config: - $ref: '#/components/schemas/LQMConfig' + lqm_enabled: description: 'The link quality monitoring parameters. ' + type: boolean + name: + description: 'The name of the WAN interface config. + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceScreenV2N2: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number lqm_enabled: description: 'The link quality monitoring parameters. @@ -2573,58 +2610,3390 @@ components: ' type: string - tags: - description: 'An information field that can be added to identify the application. - Maximum 10 Unique tags of length 1024 each are allowed. + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceScreenV2N3: + properties: + bfd_mode: + 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. ' - items: - description: Tags - type: string - type: array - type: - description: 'Type of WAN. + enum: + - aggressive + - non_aggressive + type: string + bw_config_mode: + description: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceScreenV2N4: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_config: + $ref: '#/components/schemas/LQMConfig' + description: 'The link quality monitoring parameters. + + ' + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceScreenV2N5: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_config: + $ref: '#/components/schemas/LQMConfig' + description: 'The link quality monitoring parameters. + + ' + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. ' + items: + description: Tags + type: string + type: array + type: + description: Type enum: - PUBLIC_WAN - PRIVATE_WAN type: string - use_for_application_reachability_probes: - description: 'Indicates if the use for application reachability probe is - selected. - - ' - type: boolean - use_for_controller_connections: - description: "Indicates if the use for controller connections is selected.\ - \ \n" - type: boolean - use_lqm_for_non_hub_paths: - description: Use Lqm For Non Hub Paths - type: boolean - vpnlink_configuration: - $ref: '#/components/schemas/VPNLinkConfiguration' - description: 'The configuration of the VPN link. - - ' - required: - - label_id - - bfd_mode - - bw_config_mode - - network_id -info: - contact: {} - description: List of APIs used to manage your site specific configuration attributes, - and HA configuration for both branch and data center sites. - title: Site Configuration - version: Latest -openapi: 3.0.0 -paths: - /v2.0/api/tenants/{tenant_id}/hubserviceendpoints: + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceScreenV2N6: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_config: + $ref: '#/components/schemas/LQMConfig' + description: 'The link quality monitoring parameters. + + ' + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'Type of WAN. + + ' + enum: + - PUBLIC_WAN + - PRIVATE_WAN + type: string + use_for_application_reachability_probes: + description: 'Indicates if the use for application reachability probe is + selected. + + ' + type: boolean + use_for_controller_connections: + description: 'Indicates if the use for controller connections is selected. + + ' + type: boolean + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceScreenV2N7: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_config: + $ref: '#/components/schemas/LQMConfig' + description: 'The link quality monitoring parameters. + + ' + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'Type of WAN. + + ' + enum: + - PUBLIC_WAN + - PRIVATE_WAN + type: string + use_for_application_reachability_probes: + description: 'Indicates if the use for application reachability probe is + selected. + + ' + type: boolean + use_for_controller_connections: + description: 'Indicates if the use for controller connections is selected. + + ' + type: boolean + use_lqm_for_non_hub_paths: + description: 'Indicates if the use for lqm for non hub paths is enabled. + + ' + type: boolean + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceState: + properties: + id: + description: 'The ID of the WAN interface. + + ' + type: string + operational_state: + description: 'The operational state of the site WAN interface. + + ' + type: boolean + WANInterfaceV2N2: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + required: + - bfd_mode + WANInterfaceV2N3: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config. + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config. + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - bfd_mode + WANInterfaceV2N4: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_config: + $ref: '#/components/schemas/LQMConfig' + description: 'The link quality monitoring parameters. + + ' + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - bfd_mode + WANInterfaceV2N5: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_config: + $ref: '#/components/schemas/LQMConfig' + description: 'The link quality monitoring parameters. + + ' + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: Type + enum: + - PUBLIC_WAN + - PRIVATE_WAN + type: string + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'Vpnlink Configuration: Valid ' + required: + - bfd_mode + WANInterfaceV2N6: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_config: + $ref: '#/components/schemas/LQMConfig' + description: 'The link quality monitoring parameters. + + ' + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'Type of WAN. + + ' + enum: + - PUBLIC_WAN + - PRIVATE_WAN + type: string + use_for_application_reachability_probes: + description: 'Indicates if the use for application reachability probe is + selected. + + ' + type: boolean + use_for_controller_connections: + description: "Indicates if the use for controller connections is selected.\ + \ \n" + type: boolean + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceV2N7: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_config: + $ref: '#/components/schemas/LQMConfig' + description: 'The link quality monitoring parameters. + + ' + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'Type of WAN. + + ' + enum: + - PUBLIC_WAN + - PRIVATE_WAN + type: string + use_for_application_reachability_probes: + description: 'Indicates if the use for application reachability probe is + selected. + + ' + type: boolean + use_for_controller_connections: + description: "Indicates if the use for controller connections is selected.\ + \ \n" + type: boolean + use_lqm_for_non_hub_paths: + description: Use Lqm For Non Hub Paths + type: boolean + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id +info: + contact: {} + description: List of APIs used to manage your site specific configuration attributes, + and HA configuration for both branch and data center sites. + title: Site Configuration + version: Latest +openapi: 3.0.0 +paths: + /v2.0/api/tenants/{tenant_id}/hubserviceendpoints: + get: + description: Get the hub service endpoints of a tenant. + operationId: get-v2.0-api-tenants-tenant_id-hubserviceendpoints + 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/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/HubServiceEndpointConfig' + type: array + type: object + description: Successful Operation + summary: Get Hub Service Endpoints of Tenant (v2.0) + tags: + - Site Configuration + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/hubserviceendpoints: + get: + description: Get the hub service endpoint for a site of a given tenant using + the tenant ID and site ID. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-hubserviceendpoints + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the remote site. More details on the site can be retrieved + by querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HubServiceEndpointConfig' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SITE_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Hub Service Endpoint for Site of Tenant (v2.0) + tags: + - Site Configuration + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/siteciphers: + get: + description: List the ciphers for a particular site. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-siteciphers + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + 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/SiteCipher' + type: array + type: object + description: Successful Operation + summary: Get Site Ciphers (v2.0) + tags: + - Site Configuration + put: + description: Update the ciphers for a particular site. + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-siteciphers + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteCipherScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SiteCipher' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Site Cipher (v2.0) + tags: + - Site Configuration + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/spokeclusters: + get: + description: List all the spoke clusters for a particular site. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-spokeclusters + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SpokeCluster' + type: array + type: object + description: Successful Operation + summary: Get Spoke Clusters (v2.0) + tags: + - Site Configuration + post: + description: Create cluster to determine which data center communicates with + which branch devices. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-spokeclusters + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeCluster' + description: Details of the spokecluster to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeCluster' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: SPOKECLUSTER_CONFIG_INVALID_SITE + - code: SPOKECLUSTER_CONFIG_EXCEEDS_LIMIT + - code: ADVERTISEMENT_INTERVAL_INVALID_DECIMAL + - code: ADVERTISEMENT_INTERVAL_REQD + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Spoke Cluster (v2.0) + tags: + - Site Configuration + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/spokeclusters/query: + post: + description: Query all the spoke clusters. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-spokeclusters-query + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeClusterQuery' + description: Query Details for the spokecluster + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SpokeClusterQueryFilter' + 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 Spoke Clusters (v2.0) + tags: + - Site Configuration + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/spokeclusters/{spoke_cluster_id}: + delete: + description: Delete a spoke cluster. + operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-spokeclusters-spoke_cluster_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the spoke cluster. + in: path + name: spoke_cluster_id + required: true + schema: + description: Spoke Cluster Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeCluster' + description: Successful Operation + summary: Delete Spoke Cluster (v2.0) + tags: + - Site Configuration + get: + description: Get all the details of the spoke cluster. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-spokeclusters-spoke_cluster_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the spoke cluster. + in: path + name: spoke_cluster_id + required: true + schema: + description: Spoke Cluster Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeCluster' + description: Successful Operation + summary: Get Spoke Cluster Details (v2.0) + tags: + - Site Configuration + put: + description: Details of the spoke cluster that needs to be modified. + operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-spokeclusters-spoke_cluster_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the spoke cluster. + in: path + name: spoke_cluster_id + required: true + schema: + description: Spoke Cluster Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeCluster' + description: Details of the spokecluster to be modified + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeCluster' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: ADVERTISEMENT_INTERVAL_INVALID_DECIMAL + - code: ADVERTISEMENT_INTERVAL_REQD + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Spoke Cluster (v2.0) + tags: + - Site Configuration + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/spokeclusters/{spoke_cluster_id}/operations: + post: + description: Handle all the actions performed on the spoke cluster. + operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-spokeclusters-spoke_cluster_id-operations + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the spoke cluster. + in: path + name: spoke_cluster_id + required: true + schema: + description: Spoke Cluster Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeClusterOperations' + description: Spokecluster operation action + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeClusterOperations' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Handle Operations on Spokecluster (v2.0) + tags: + - Site Configuration + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/spokeclusters/{spoke_cluster_id}/status: + get: + description: Get the status of the spoke clusters. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-spokeclusters-spoke_cluster_id-status + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the spoke cluster. + in: path + name: spoke_cluster_id + required: true + schema: + description: Spoke Cluster Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeClusterStatus' + description: Successful Operation + summary: Get Spoke Cluster Status (v2.0) + tags: + - Site Configuration + /v2.0/api/tenants/{tenant_id}/sites/{site_id}/status: + get: + description: Get the status of the site. + operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-status + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SiteStatus' + description: Successful Operation + summary: Get Site Status (v2.0) + tags: + - Site Configuration + /v2.0/api/tenants/{tenant_id}/spokeclusters/query: + post: + description: Query the details for the spoke cluster. + operationId: post-v2.0-api-tenants-tenant_id-spokeclusters-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/SpokeClusterQuery' + description: Query Details for the spokecluster + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SpokeClusterQueryFilterResponse' + 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 Spoke Clusters (v2.0) + tags: + - Site Configuration + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/waninterfaces/{wan_interface_id}/state: + get: + description: Get the status of the elemant WAN interface. + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-waninterfaces-wan_interface_id-state + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementWANInterfaceState' + description: Successful Operation + summary: Get Element WAN Interface Status (v2.1) + tags: + - Site Configuration + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces: + get: + description: Get all Site WAN interfaces + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-waninterfaces + parameters: + - description: Tenant Id + 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 + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterface' + type: array + type: object + description: Successful Operation + summary: Get all Site WAN interfaces (v2.1) + tags: + - Site Configuration + post: + description: Create site WAN interface + operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-waninterfaces + parameters: + - description: Tenant Id + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterface' + description: Successful Operation + summary: Create site WAN interface (v2.1) + tags: + - Site Configuration + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/query: + post: + description: Query db for Site WAN interfaces that match query parameters + operationId: post-v2.1-api-tenants-tenant_id-sites-site_id-waninterfaces-query + parameters: + - description: Tenant Id + 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 + 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/WANInterfaceQuery' + type: array + type: object + description: Successful Operation + summary: Query db for Site WAN interfaces that match query parameters (v2.1) + tags: + - Site Configuration + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/{wan_interface_id}: + delete: + description: Delete existing WAN interface + operationId: delete-v2.1-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: Tenant Id + 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: 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/WANInterface' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_CONFIGURED + - code: WAN_INTERFACE_CONFIG_IN_ZONE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete existing WAN interface (v2.1) + tags: + - Site Configuration + get: + description: Get a specific Site WAN interface + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: Tenant Id + 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: 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/WANInterface' + description: Successful Operation + summary: Get a specific Site WAN interface (v2.1) + tags: + - Site Configuration + put: + description: Update the Site WAN interface + operationId: put-v2.1-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: Tenant Id + 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: WAN interface Id + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterface' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_DUPLICATE_LABEL_FOR_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update the Site WAN interface (v2.1) + tags: + - Site Configuration + /v2.1/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/{wan_interface_id}/status: + get: + description: Get the status of a specific site wan interface. + operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id-status + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceState' + description: Successful Operation + summary: Get Site WAN Interface Status (v2.1) + tags: + - Site Configuration + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces: + get: + description: Get all Site WAN interfaces + operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-waninterfaces + parameters: + - description: Tenant Id + 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 + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceV2N3' + type: array + type: object + description: Successful Operation + summary: Get all Site WAN interfaces (v2.2) + tags: + - Site Configuration + post: + description: Create a new Site WAN interface + operationId: post-v2.2-api-tenants-tenant_id-sites-site_id-waninterfaces + parameters: + - description: Tenant Id + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_DUPLICATE_LABEL_FOR_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create a new Site WAN interface (v2.2) + tags: + - Site Configuration + /v2.2/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/{wan_interface_id}: + delete: + description: Delete existing WAN interface + operationId: delete-v2.2-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: Tenant Id + 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: 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/WANInterfaceV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_CONFIGURED + - code: WAN_INTERFACE_CONFIG_IN_ZONE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete existing WAN interface (v2.2) + tags: + - Site Configuration + get: + description: Get a specific Site WAN interface + operationId: get-v2.2-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: Tenant Id + 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: 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/WANInterfaceV2N2' + description: Successful Operation + summary: Get a specific Site WAN interface (v2.2) + tags: + - Site Configuration + put: + description: Update the Site WAN interface + operationId: put-v2.2-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: Tenant Id + 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: WAN interface Id + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_DUPLICATE_LABEL_FOR_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update the Site WAN interface (v2.2) + tags: + - Site Configuration + /v2.3/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces: + get: + description: Get all Site WAN interfaces + operationId: get-v2.3-api-tenants-tenant_id-sites-site_id-waninterfaces + parameters: + - description: Tenant Id + 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 + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceV2N3' + type: array + type: object + description: Successful Operation + summary: Get all Site WAN interfaces (v2.3) + tags: + - Site Configuration + post: + description: Create a new Site WAN interface + operationId: post-v2.3-api-tenants-tenant_id-sites-site_id-waninterfaces + parameters: + - description: Tenant Id + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N3' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_DUPLICATE_LABEL_FOR_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create a new Site WAN interface (v2.3) + tags: + - Site Configuration + /v2.3/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/query: + post: + description: Query db for Site WAN interfaces that match query parameters + operationId: post-v2.3-api-tenants-tenant_id-sites-site_id-waninterfaces-query + parameters: + - description: Tenant Id + 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 + 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/WANInterfaceQuery' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + schema: + $ref: '#/components/schemas/Error' + description: Bad request + summary: Query db for Site WAN interfaces that match query parameters (v2.3) + tags: + - Site Configuration + /v2.3/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/{wan_interface_id}: + delete: + description: Delete existing WAN interface + operationId: delete-v2.3-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: Tenant Id + 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: 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/WANInterfaceV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_CONFIGURED + - code: WAN_INTERFACE_CONFIG_IN_ZONE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete existing WAN interface (v2.3) + tags: + - Site Configuration + get: + description: Get a specific Site WAN interface + operationId: get-v2.3-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: Tenant Id + 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: 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/WANInterfaceV2N3' + description: Successful Operation + summary: Get a specific Site WAN interface (v2.3) + tags: + - Site Configuration + put: + description: Update the Site WAN interface + operationId: put-v2.3-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: Tenant Id + 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: WAN interface Id + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N3' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_DUPLICATE_LABEL_FOR_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update the Site WAN interface (v2.3) + tags: + - Site Configuration + /v2.4/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces: + get: + description: Get all Site WAN interfaces + operationId: get-v2.4-api-tenants-tenant_id-sites-site_id-waninterfaces + parameters: + - description: Tenant Id + 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 + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceV2N4' + type: array + type: object + description: Successful Operation + summary: Get all Site WAN interfaces (v2.4) + tags: + - Site Configuration + post: + description: Create a new Site WAN interface + operationId: post-v2.4-api-tenants-tenant_id-sites-site_id-waninterfaces + parameters: + - description: Tenant Id + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N4' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N4' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_DUPLICATE_LABEL_FOR_SITE + - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED + - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC + - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create a new Site WAN interface (v2.4) + tags: + - Site Configuration + /v2.4/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/query: + post: + description: Queries the DB for Site WAN Interfaces that match the query parameters. + operationId: post-v2.4-api-tenants-tenant_id-sites-site_id-waninterfaces-query + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site 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/WANInterfaceQuery' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Site WAN Interfaces (v2.4) + tags: + - Site Configuration + /v2.4/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/{wan_interface_id}: + delete: + description: Delete existing WAN interface + operationId: delete-v2.4-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: Tenant Id + 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: 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/WANInterfaceV2N4' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_CONFIGURED + - code: WAN_INTERFACE_CONFIG_IN_ZONE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete existing WAN interface (v2.4) + tags: + - Site Configuration + get: + description: Get a specific Site WAN interface + operationId: get-v2.4-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: Tenant Id + 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: 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/WANInterfaceV2N4' + description: Successful Operation + summary: Get a specific Site WAN interface (v2.4) + tags: + - Site Configuration + put: + description: Update the Site WAN interface + operationId: put-v2.4-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: Tenant Id + 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: WAN interface Id + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N4' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N4' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_DUPLICATE_LABEL_FOR_SITE + - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED + - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC + - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update the Site WAN interface (v2.4) + tags: + - Site Configuration + /v2.5/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces: + get: + description: Get all Site WAN interfaces + operationId: get-v2.5-api-tenants-tenant_id-sites-site_id-waninterfaces + parameters: + - description: Tenant Id + 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 + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceV2N5' + type: array + type: object + description: Successful Operation + summary: Get all Site WAN interfaces (v2.5) + tags: + - Site Configuration + post: + description: Create a new Site WAN interface + operationId: post-v2.5-api-tenants-tenant_id-sites-site_id-waninterfaces + parameters: + - description: Tenant Id + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N5' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N5' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create a new Site WAN interface (v2.5) + tags: + - Site Configuration + /v2.5/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/query: + post: + description: Queries the DB for Site WAN Interfaces that match the query parameters. + operationId: post-v2.5-api-tenants-tenant_id-sites-site_id-waninterfaces-query + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site 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/WANInterfaceQuery' + type: array + type: object + description: Successful Operation + summary: Query DB for Site WAN Interfaces (v2.5) + tags: + - Site Configuration + /v2.5/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/{wan_interface_id}: + delete: + description: Delete existing WAN interface + operationId: delete-v2.5-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: Tenant Id + 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: 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/WANInterfaceV2N5' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_CONFIGURED + - code: WAN_INTERFACE_CONFIG_IN_ZONE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete existing WAN interface (v2.5) + tags: + - Site Configuration + get: + description: Get a specific Site WAN interface + operationId: get-v2.5-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: Tenant Id + 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: 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/WANInterfaceV2N5' + description: Successful Operation + summary: Get a specific Site WAN interface (v2.5) + tags: + - Site Configuration + put: + description: Update the Site WAN interface + operationId: put-v2.5-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: Tenant Id + 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: WAN interface Id + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N5' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N5' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED + - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC + - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Resource Not Found + summary: Update the Site WAN interface (v2.5) + tags: + - Site Configuration + /v2.6/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces: + get: + description: Get all the WAN interfaces for the site. + operationId: get-v2.6-api-tenants-tenant_id-sites-site_id-waninterfaces + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceV2N6' + type: array + type: object + description: Successful Operation + summary: Get Site WAN Interfaces (v2.6) + tags: + - Site Configuration + post: + description: Create a site WAN interface. + operationId: post-v2.6-api-tenants-tenant_id-sites-site_id-waninterfaces + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N6' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceV2N6' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Site WAN Interface (v2.6) + tags: + - Site Configuration + /v2.6/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/{wan_interface_id}: + delete: + description: Delete an existing WAN interface. + operationId: delete-v2.6-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N6' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_CONFIGURED + - code: WAN_INTERFACE_CONFIG_IN_ZONE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete WAN Interface (v2.6) + tags: + - Site Configuration + get: + description: Get a specific site wan interface. + operationId: get-v2.6-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N6' + description: Successful Operation + summary: Get Specific Site WAN Interface (v2.6) + tags: + - Site Configuration + put: + description: Update the site WAN interface. + operationId: put-v2.6-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N6' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N6' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED + - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC + - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Resource Not Found + summary: Update Site WAN Interface (v2.6) + tags: + - Site Configuration + /v2.6/api/tenants/{tenant_id}/waninterfaces/query: + post: + description: Queries the DB for Site WAN Interfaces that match the query parameters. + operationId: post-v2.6-api-tenants-tenant_id-waninterfaces-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/WANInterfaceQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceQuery' + type: array + type: object + description: Successful Operation + summary: Query DB for Site WAN Interfaces (v2.6) + tags: + - Site Configuration + /v2.7/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces: get: - description: Get the hub service endpoints of a tenant. - operationId: get-v2.0-api-tenants-tenant_id-hubserviceendpoints + description: Get all the WAN interfaces for the site. + operationId: get-v2.7-api-tenants-tenant_id-sites-site_id-waninterfaces parameters: - description: The tenant ID. in: path @@ -2633,6 +6002,14 @@ paths: schema: description: Tenant Id type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string responses: '200': content: @@ -2643,18 +6020,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/HubServiceEndpointConfig' + $ref: '#/components/schemas/WANInterfaceV2N7' type: array type: object description: Successful Operation - summary: Get Hub Service Endpoints of Tenant (v2.0) + summary: Get Site WAN Interfaces (v2.7) tags: - Site Configuration - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/hubserviceendpoints: - get: - description: Get the hub service endpoint for a site of a given tenant using - the tenant ID and site ID. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-hubserviceendpoints + post: + description: Create a site WAN interface. + operationId: post-v2.7-api-tenants-tenant_id-sites-site_id-waninterfaces parameters: - description: The tenant ID. in: path @@ -2663,20 +6038,25 @@ paths: schema: description: Tenant Id type: string - - description: ID of the remote site. More details on the site can be retrieved - by querying the sites API. + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. in: path name: site_id required: true schema: description: Site Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N7' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubServiceEndpointConfig' + $ref: '#/components/schemas/WANInterfaceV2N7' description: Successful Operation '400': content: @@ -2684,17 +6064,80 @@ paths: example: value: _error: - - code: SITE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED + - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC + - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT + - code: WANINTERFACE_USE_FOR_NON_HUB_PATHS_INVALID + - code: WANINTERFACE_USE_FOR_NON_HUB_PATHS_NOT_ALLOWED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Hub Service Endpoint for Site of Tenant (v2.0) + summary: Create Site WAN Interface (v2.7) + tags: + - Site Configuration + /v2.7/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/{wan_interface_id}: + delete: + description: Delete an existing WAN interface. + operationId: delete-v2.7-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N7' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_CONFIGURED + - code: WAN_INTERFACE_CONFIG_IN_ZONE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete WAN Interface (v2.7) tags: - Site Configuration - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/siteciphers: get: - description: List the ciphers for a particular site. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-siteciphers + description: Get a specific site wan interface. + operationId: get-v2.7-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id parameters: - description: The tenant ID. in: path @@ -2711,26 +6154,26 @@ paths: schema: description: Site Id type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/BulkResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SiteCipher' - type: array - type: object + $ref: '#/components/schemas/WANInterfaceV2N7' description: Successful Operation - summary: Get Site Ciphers (v2.0) + summary: Get Specific Site WAN Interface (v2.7) tags: - Site Configuration put: - description: Update the ciphers for a particular site. - operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-siteciphers + description: Update the site WAN interface. + operationId: put-v2.7-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id parameters: - description: The tenant ID. in: path @@ -2747,17 +6190,24 @@ paths: schema: description: Site Id type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SiteCipherScreen' + $ref: '#/components/schemas/WANInterfaceScreenV2N7' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteCipher' + $ref: '#/components/schemas/WANInterfaceV2N7' description: Successful Operation '400': content: @@ -2766,17 +6216,38 @@ paths: value: _error: - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED + - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC + - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT + - code: WANINTERFACE_USE_FOR_NON_HUB_PATHS_INVALID + - code: WANINTERFACE_USE_FOR_NON_HUB_PATHS_NOT_ALLOWED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Site Cipher (v2.0) + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Resource Not Found + summary: Update Site WAN Interface (v2.7) tags: - Site Configuration - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/spokeclusters: - get: - description: List all the spoke clusters for a particular site. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-spokeclusters + /v2.7/api/tenants/{tenant_id}/waninterfaces/query: + post: + description: Queries the DB for Site WAN Interfaces that match the query parameters. + operationId: post-v2.7-api-tenants-tenant_id-waninterfaces-query parameters: - description: The tenant ID. in: path @@ -2785,35 +6256,42 @@ paths: schema: description: Tenant Id type: string - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceQuery' responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/ListQueryResponse' - properties: items: items: - $ref: '#/components/schemas/SpokeCluster' + $ref: '#/components/schemas/WANInterfaceQueryFilterV2N7' type: array type: object description: Successful Operation - summary: Get Spoke Clusters (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Site WAN Interfaces (v2.7) tags: - Site Configuration - post: - description: Create cluster to determine which data center communicates with - which branch devices. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-spokeclusters + /v3.0/api/tenants/{tenant_id}/sites/{site_id}/admin_state: + put: + description: Update an existing site. + operationId: put-v3.0-api-tenants-tenant_id-sites-site_id-admin_state parameters: - description: The tenant ID. in: path @@ -2834,14 +6312,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SpokeCluster' - description: Details of the spokecluster to be created + $ref: '#/components/schemas/Site' + description: Details of the site to update responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SpokeCluster' + $ref: '#/components/schemas/Site' description: Successful Operation '400': content: @@ -2849,22 +6327,19 @@ paths: example: value: _error: - - code: INVALID_JSON_INPUT + - code: SITE_NOT_FOUND - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: SPOKECLUSTER_CONFIG_INVALID_SITE - - code: SPOKECLUSTER_CONFIG_EXCEEDS_LIMIT - - code: ADVERTISEMENT_INTERVAL_INVALID_DECIMAL - - code: ADVERTISEMENT_INTERVAL_REQD + - code: INVALID_JSON_COMMON_ATTR_MISMATCH schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Spoke Cluster (v2.0) + summary: Update a Site (v3.0) tags: - Site Configuration - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/spokeclusters/query: - post: - description: Query all the spoke clusters. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-spokeclusters-query + /v3.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters: + get: + description: List all the hub clusters. + operationId: get-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters parameters: - description: The tenant ID. in: path @@ -2881,23 +6356,17 @@ paths: schema: description: Site Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SpokeClusterQuery' - description: Query Details for the spokecluster responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/SpokeClusterQueryFilter' + $ref: '#/components/schemas/HubCluster' type: array type: object description: Successful Operation @@ -2907,17 +6376,17 @@ paths: example: value: _error: - - code: BAD_REQUEST + - code: INVALID_VALUE_RANGE + - code: NAME_EXCEEDS_LIMIT schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Spoke Clusters (v2.0) + summary: Get Hub Clusters (v3.0) tags: - Site Configuration - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/spokeclusters/{spoke_cluster_id}: - delete: - description: Delete a spoke cluster. - operationId: delete-v2.0-api-tenants-tenant_id-sites-site_id-spokeclusters-spoke_cluster_id + post: + description: Creates a new hub cluster. + operationId: post-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters parameters: - description: The tenant ID. in: path @@ -2934,26 +6403,37 @@ paths: schema: description: Site Id type: string - - description: ID of the spoke cluster. - in: path - name: spoke_cluster_id - required: true - schema: - description: Spoke Cluster Id - type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HubClusterScreen' + description: Details of the hub cluster to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SpokeCluster' + $ref: '#/components/schemas/HubCluster' description: Successful Operation - summary: Delete Spoke Cluster (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_VALUE_RANGE + - code: NAME_EXCEEDS_LIMIT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Hub Cluster (v3.0) tags: - Site Configuration - get: - description: Get all the details of the spoke cluster. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-spokeclusters-spoke_cluster_id + /v3.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters/{hub_cluster_id}: + delete: + description: Delete an existing WAN interface. + operationId: delete-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id parameters: - description: The tenant ID. in: path @@ -2970,26 +6450,36 @@ paths: schema: description: Site Id type: string - - description: ID of the spoke cluster. + - description: ID of the hub cluster. in: path - name: spoke_cluster_id + name: hub_cluster_id required: true schema: - description: Spoke Cluster Id + description: Hub Cluster Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SpokeCluster' + $ref: '#/components/schemas/HubCluster' description: Successful Operation - summary: Get Spoke Cluster Details (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: CLUSTER_CONTAINS_CLUSTER_MEMBERS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Hub Cluster (v3.0) tags: - Site Configuration - put: - description: Details of the spoke cluster that needs to be modified. - operationId: put-v2.0-api-tenants-tenant_id-sites-site_id-spokeclusters-spoke_cluster_id + get: + description: List a specific hub cluster. + operationId: get-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id parameters: - description: The tenant ID. in: path @@ -3006,25 +6496,19 @@ paths: schema: description: Site Id type: string - - description: ID of the spoke cluster. + - description: ID of the hub cluster. in: path - name: spoke_cluster_id + name: hub_cluster_id required: true schema: - description: Spoke Cluster Id + description: Hub Cluster Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SpokeCluster' - description: Details of the spokecluster to be modified responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SpokeCluster' + $ref: '#/components/schemas/HubCluster' description: Successful Operation '400': content: @@ -3032,21 +6516,17 @@ paths: example: value: _error: - - code: INVALID_JSON_INPUT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: ADVERTISEMENT_INTERVAL_INVALID_DECIMAL - - code: ADVERTISEMENT_INTERVAL_REQD - - code: ADVERTISEMENT_INTERVAL_LOWER_THAN_ONE_SEC_ERR + - code: INVALID_VALUE_RANGE + - code: NAME_EXCEEDS_LIMIT schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Spoke Cluster (v2.0) + summary: Get Specific Hub Cluster (v3.0 tags: - Site Configuration - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/spokeclusters/{spoke_cluster_id}/operations: - post: - description: Handle all the actions performed on the spoke cluster. - operationId: post-v2.0-api-tenants-tenant_id-sites-site_id-spokeclusters-spoke_cluster_id-operations + put: + description: Details of the hub cluster to be created. + operationId: put-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id parameters: - description: The tenant ID. in: path @@ -3063,43 +6543,33 @@ paths: schema: description: Site Id type: string - - description: ID of the spoke cluster. + - description: ID of the hub cluster. in: path - name: spoke_cluster_id + name: hub_cluster_id required: true schema: - description: Spoke Cluster Id + description: Hub Cluster Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SpokeClusterOperations' - description: Spokecluster operation action + $ref: '#/components/schemas/HubClusterScreen' + description: Details of the hub cluster to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SpokeClusterOperations' + $ref: '#/components/schemas/HubCluster' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Handle Operations on Spokecluster (v2.0) + summary: Update Hub Cluster (v3.0) tags: - Site Configuration - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/spokeclusters/{spoke_cluster_id}/status: + /v3.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters/{hub_cluster_id}/hubclustermembers: get: - description: Get the status of the spoke clusters. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-spokeclusters-spoke_cluster_id-status + description: List all the hub cluster members. + operationId: get-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers parameters: - description: The tenant ID. in: path @@ -3116,27 +6586,33 @@ paths: schema: description: Site Id type: string - - description: ID of the spoke cluster. + - description: ID of the hub cluster. in: path - name: spoke_cluster_id + name: hub_cluster_id required: true schema: - description: Spoke Cluster Id + description: Hub Cluster Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SpokeClusterStatus' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/HubClusterMemberScreen' + type: array + type: object description: Successful Operation - summary: Get Spoke Cluster Status (v2.0) + summary: Get Hub Cluster Members (v3.0) tags: - Site Configuration - /v2.0/api/tenants/{tenant_id}/sites/{site_id}/status: - get: - description: Get the status of the site. - operationId: get-v2.0-api-tenants-tenant_id-sites-site_id-status + post: + description: Creates new hub cluster members. + operationId: post-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers parameters: - description: The tenant ID. in: path @@ -3153,65 +6629,33 @@ paths: schema: description: Site Id type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SiteStatus' - description: Successful Operation - summary: Get Site Status (v2.0) - tags: - - Site Configuration - /v2.0/api/tenants/{tenant_id}/spokeclusters/query: - post: - description: Query the details for the spoke cluster. - operationId: post-v2.0-api-tenants-tenant_id-spokeclusters-query - parameters: - - description: The tenant ID. + - description: ID of the hub cluster. in: path - name: tenant_id + name: hub_cluster_id required: true schema: - description: Tenant Id + description: Hub Cluster Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SpokeClusterQuery' - description: Query Details for the spokecluster + $ref: '#/components/schemas/HubClusterMemberScreen' + description: Details of the hub cluster member to be created responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SpokeClusterQueryFilterResponse' - type: array - type: object + $ref: '#/components/schemas/HubClusterMemberScreen' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Spoke Clusters (v2.0) + summary: Creates all Hub Cluster Members (v3.0) tags: - Site Configuration - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/elements/{element_id}/waninterfaces/{wan_interface_id}/state: - get: - description: Get the status of the elemant WAN interface. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-elements-element_id-waninterfaces-wan_interface_id-state + /v3.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters/{hub_cluster_id}/hubclustermembers/{hub_cluster_member_id}: + delete: + description: Delete a specific hub cluster member. + operationId: delete-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers-hub_cluster_member_id parameters: - description: The tenant ID. in: path @@ -3228,34 +6672,43 @@ paths: schema: description: Site Id type: string - - description: ID of the element. + - description: ID of the hub cluster. in: path - name: element_id + name: hub_cluster_id required: true schema: - description: Element Id + description: Hub Cluster Id type: string - - description: ID of the WAN interface. + - description: ID of the hub cluster member. in: path - name: wan_interface_id + name: hub_cluster_member_id required: true schema: - description: Wan Interface Id + description: Hub Cluster Member Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementWANInterfaceState' + $ref: '#/components/schemas/HubClusterMember' description: Successful Operation - summary: Get Element WAN Interface Status (v2.1) + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Deletes Specific Hub Cluster Member (v3.0) tags: - Site Configuration - /v2.1/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/{wan_interface_id}/status: get: - description: Get the status of a specific site wan interface. - operationId: get-v2.1-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id-status + description: List a specific hub cluster member. + operationId: get-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers-hub_cluster_member_id parameters: - description: The tenant ID. in: path @@ -3272,27 +6725,35 @@ paths: schema: description: Site Id type: string - - description: ID of the WAN interface. + - description: ID of the hub cluster. in: path - name: wan_interface_id + name: hub_cluster_id required: true schema: - description: Wan Interface Id + description: Hub Cluster Id + type: string + - description: ID of the hub cluster member. + in: path + name: hub_cluster_member_id + required: true + schema: + description: Hub Cluster Member Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceState' + items: + $ref: '#/components/schemas/HubClusterMember' + type: array description: Successful Operation - summary: Get Site WAN Interface Status (v2.1) + summary: Get Specific Hub Cluster Member (v3.0) tags: - Site Configuration - /v2.4/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/query: - post: - description: Queries the DB for Site WAN Interfaces that match the query parameters. - operationId: post-v2.4-api-tenants-tenant_id-sites-site_id-waninterfaces-query + put: + description: Details of the hub cluster member to be created. + operationId: put-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers-hub_cluster_member_id parameters: - description: The tenant ID. in: path @@ -3309,85 +6770,42 @@ paths: schema: description: Site 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/WANInterfaceQuery' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: WANINTERFACE_CONFIG_INVALID_SITE_ID - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query DB for Site WAN Interfaces (v2.4) - tags: - - Site Configuration - /v2.5/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/query: - post: - description: Queries the DB for Site WAN Interfaces that match the query parameters. - operationId: post-v2.5-api-tenants-tenant_id-sites-site_id-waninterfaces-query - parameters: - - description: The tenant ID. + - description: ID of the hub cluster. in: path - name: tenant_id + name: hub_cluster_id required: true schema: - description: Tenant Id + description: Hub Cluster Id type: string - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. + - description: ID of the hub cluster member. in: path - name: site_id + name: hub_cluster_member_id required: true schema: - description: Site Id + description: Hub Cluster Member Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceQuery' + $ref: '#/components/schemas/HubClusterMemberScreen' + description: Details of the hub cluster member to be created responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/WANInterfaceQuery' - type: array - type: object + items: + $ref: '#/components/schemas/HubClusterMemberScreen' + type: array description: Successful Operation - summary: Query DB for Site WAN Interfaces (v2.5) + summary: Update Specific Hub Cluster Member (v3.0) tags: - Site Configuration - /v2.6/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces: - get: - description: Get all the WAN interfaces for the site. - operationId: get-v2.6-api-tenants-tenant_id-sites-site_id-waninterfaces + ? /v3.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters/{hub_cluster_id}/hubclustermembers/{hub_cluster_member_id}/status + : get: + description: List the state of a specific hub cluster member. + operationId: get-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers-hub_cluster_member_id-status parameters: - description: The tenant ID. in: path @@ -3404,26 +6822,36 @@ paths: schema: description: Site Id type: string + - description: ID of the hub cluster. + in: path + name: hub_cluster_id + required: true + schema: + description: Hub Cluster Id + type: string + - description: ID of the hub cluster member. + in: path + name: hub_cluster_member_id + required: true + schema: + description: Hub Cluster Member Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/WANInterfaceV2N6' - type: array - type: object + items: + $ref: '#/components/schemas/HubClusterMember' + type: array description: Successful Operation - summary: Get Site WAN Interfaces (v2.6) + summary: Get Specific Hub Cluster Member State (v3.0) tags: - Site Configuration - post: - description: Create a site WAN interface. - operationId: post-v2.6-api-tenants-tenant_id-sites-site_id-waninterfaces + /v3.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters/{hub_cluster_id}/status: + get: + description: List the state of a specific hub cluster. + operationId: get-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id-status parameters: - description: The tenant ID. in: path @@ -3440,24 +6868,19 @@ paths: schema: description: Site Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/WANInterfaceScreenV2N6' + - description: ID of the hub cluster. + in: path + name: hub_cluster_id + required: true + schema: + description: Hub Cluster Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/BulkResponse' - - properties: - items: - items: - $ref: '#/components/schemas/WANInterfaceV2N6' - type: array - type: object + $ref: '#/components/schemas/HubCluster' description: Successful Operation '400': content: @@ -3465,17 +6888,18 @@ paths: example: value: _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_VALUE_RANGE + - code: NAME_EXCEEDS_LIMIT schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Site WAN Interface (v2.6) + summary: Get Specific Hub Cluster State (v3.0) tags: - Site Configuration - /v2.6/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/{wan_interface_id}: - delete: - description: Delete an existing WAN interface. - operationId: delete-v2.6-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + /v4.0/api/tenants/{tenant_id}/hubclusters/query: + post: + description: Query hub clusters. + operationId: post-v4.0-api-tenants-tenant_id-hubclusters-query parameters: - description: The tenant ID. in: path @@ -3484,45 +6908,43 @@ paths: schema: description: Tenant Id type: string - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: ID of the WAN interface. - in: path - name: wan_interface_id - required: true - schema: - description: Wan Interface Id - type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HubClusterQueryV4' + description: Details of the hub cluster to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceV2N6' - description: Successful Operation + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/HubClusterQueryFilterV4' + type: array + type: object + description: Successful operation '400': content: application/json: example: value: _error: - - code: WAN_INTERFACE_CONFIGURED - - code: WAN_INTERFACE_CONFIG_IN_ZONE + - code: BAD_QUERY_OR_SORT_PARAMETERS schema: $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete WAN Interface (v2.6) + description: Bad request + summary: Query Hub Clusters (v4.0) tags: - Site Configuration + /v4.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters: get: - description: Get a specific site wan interface. - operationId: get-v2.6-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + description: List all the hub clusters. + operationId: get-v4.0-api-tenants-tenant_id-sites-site_id-hubclusters parameters: - description: The tenant ID. in: path @@ -3539,26 +6961,26 @@ paths: schema: description: Site Id type: string - - description: ID of the WAN interface. - in: path - name: wan_interface_id - required: true - schema: - description: Wan Interface Id - type: string responses: '200': content: - application/json: - schema: - $ref: '#/components/schemas/WANInterfaceV2N6' - description: Successful Operation - summary: Get Specific Site WAN Interface (v2.6) + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/HubClusterV4' + type: array + type: object + description: Successful operation + summary: Get Hub Clusters (v4.0) tags: - Site Configuration - put: - description: Update the site WAN interface. - operationId: put-v2.6-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + post: + description: Create a hub cluster. + operationId: post-v4.0-api-tenants-tenant_id-sites-site_id-hubclusters parameters: - description: The tenant ID. in: path @@ -3575,62 +6997,48 @@ paths: schema: description: Site Id type: string - - description: ID of the WAN interface. - in: path - name: wan_interface_id - required: true - schema: - description: Wan Interface Id - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceScreenV2N6' + $ref: '#/components/schemas/HubClusterV4' + description: Details of the hub cluster to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceScreenV2N6' - description: Successful Operation + $ref: '#/components/schemas/HubClusterV4' + description: Successful operation '400': content: application/json: example: value: _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: WANINTERFACE_CONFIG_INVALID_SITE_ID - - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID - - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH - - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND - - code: WANINTERFACE_CONFIG_INVALID_LABEL - - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED - - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE - - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC - - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP - - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL - - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - '404': - content: - application/json: + - code: HUB_CLUSTER_NAME_NULL_OR_EMPTY + - code: HUB_CLUSTER_NAME_EXCEEDS_LIMIT + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INVALID_TAG + - code: INVALID_HUB_SITE + - code: HUB_CLUSTER_ELEMENT_PRESENT + - code: DEFAULT_HUB_CLUSTER_EXISTS + - code: HUB_CLUSTER_NAME_NOT_UNIQUE + - code: HUB_CLUSTER_COUNT_IN_HUB_SITE_EXCEEDED + - code: DUPLICATE_SPOKE_SITES_PRESENT + - code: INVALID_PEER_SITES_PRESENT + - code: SOME_SPOKE_SITES_ALREADY_MAPPED_TO_ANOTHER_CLUSTER + - code: INVALID_VALUE_RANGE schema: $ref: '#/components/schemas/Error' - description: Resource Not Found - summary: Update Site WAN Interface (v2.6) + description: Bad request + summary: Create Hub Cluster (v4.0) tags: - Site Configuration - /v2.6/api/tenants/{tenant_id}/waninterfaces/query: - post: - description: Queries the DB for Site WAN Interfaces that match the query parameters. - operationId: post-v2.6-api-tenants-tenant_id-waninterfaces-query + /v4.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters/{hub_cluster_id}: + delete: + description: Delete a hub cluster. + operationId: delete-v4.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id parameters: - description: The tenant ID. in: path @@ -3639,32 +7047,45 @@ paths: schema: description: Tenant Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/WANInterfaceQuery' + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the hub cluster. + in: path + name: hub_cluster_id + required: true + schema: + description: Hub Cluster Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/WANInterfaceQuery' - type: array - type: object - description: Successful Operation - summary: Query DB for Site WAN Interfaces (v2.6) + $ref: '#/components/schemas/HubClusterV4' + description: Successful operation + '400': + content: + application/json: + example: + value: + _error: + - code: HUB_CLUSTER_NOT_FOUND + - code: HUB_CLUSTER_HAS_ELEMENTS + schema: + $ref: '#/components/schemas/Error' + description: Bad request + summary: Delete Hub Cluster (v4.0) tags: - Site Configuration - /v2.7/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces: get: - description: Get all the WAN interfaces for the site. - operationId: get-v2.7-api-tenants-tenant_id-sites-site_id-waninterfaces + description: List a specific hub cluster. + operationId: get-v4.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id parameters: - description: The tenant ID. in: path @@ -3681,26 +7102,36 @@ paths: schema: description: Site Id type: string + - description: ID of the hub cluster. + in: path + name: hub_cluster_id + required: true + schema: + description: Hub Cluster Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/BulkResponse' - - properties: - items: - items: - $ref: '#/components/schemas/WANInterfaceV2N7' - type: array - type: object - description: Successful Operation - summary: Get Site WAN Interfaces (v2.7) + $ref: '#/components/schemas/HubClusterV4' + description: Successful operation + '404': + content: + application/json: + example: + value: + _error: + - code: HUB_CLUSTER_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Hub cluster not found + summary: Get Specific Hub Cluster (v4.0) tags: - Site Configuration - post: - description: Create a site WAN interface. - operationId: post-v2.7-api-tenants-tenant_id-sites-site_id-waninterfaces + put: + description: Update the hub cluster. + operationId: put-v4.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id parameters: - description: The tenant ID. in: path @@ -3717,51 +7148,55 @@ paths: schema: description: Site Id type: string + - description: ID of the hub cluster. + in: path + name: hub_cluster_id + required: true + schema: + description: Hub Cluster Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceScreenV2N7' + $ref: '#/components/schemas/HubClusterV4' + description: Details of the hub cluster to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceV2N7' - description: Successful Operation + $ref: '#/components/schemas/HubClusterV4' + description: Successful operation '400': content: application/json: example: value: _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: WANINTERFACE_CONFIG_INVALID_SITE_ID - - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID - - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH - - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND - - code: WANINTERFACE_CONFIG_INVALID_LABEL - - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED - - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE - - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC - - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP - - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL - - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT - - code: WANINTERFACE_USE_FOR_NON_HUB_PATHS_INVALID - - code: WANINTERFACE_USE_FOR_NON_HUB_PATHS_NOT_ALLOWED + - code: HUB_CLUSTER_NAME_NULL_OR_EMPTY + - code: HUB_CLUSTER_NAME_EXCEEDS_LIMIT + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INVALID_TAG + - code: HUB_CLUSTER_NOT_FOUND + - code: DEFAULT_HUB_CLUSTER_EXISTS + - code: HUB_CLUSTER_NAME_NOT_UNIQUE + - code: HUB_CLUSTER_INVALID_ELEMENTS_INFO + - code: DUPLICATE_SPOKE_SITES_PRESENT + - code: INVALID_PEER_SITES_PRESENT + - code: SOME_SPOKE_SITES_ALREADY_MAPPED_TO_ANOTHER_CLUSTER + - code: HUB_CLUSTER_UNDER_MAINTENANCE + - code: HUB_CLUSTER_STATUS_NOT_FOUND schema: $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Site WAN Interface (v2.7) + description: Bad request + summary: Update Hub Cluster (v4.0) tags: - Site Configuration - /v2.7/api/tenants/{tenant_id}/sites/{site_id}/waninterfaces/{wan_interface_id}: - delete: - description: Delete an existing WAN interface. - operationId: delete-v2.7-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + /v4.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters/{hub_cluster_id}/operations: + post: + description: Operations to be performed on the hub cluster. + operationId: post-v4.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id-operations parameters: - description: The tenant ID. in: path @@ -3778,37 +7213,52 @@ paths: schema: description: Site Id type: string - - description: ID of the WAN interface. + - description: ID of the hub cluster. in: path - name: wan_interface_id + name: hub_cluster_id required: true schema: - description: Wan Interface Id + description: Hub Cluster Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HubClusterOperationV4' + description: Details of the operations to be performed on the hub cluster. responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceV2N7' - description: Successful Operation + $ref: '#/components/schemas/HubClusterStatusV4' + description: Successful operation '400': content: application/json: example: value: _error: - - code: WAN_INTERFACE_CONFIGURED - - code: WAN_INTERFACE_CONFIG_IN_ZONE + - code: HUB_CLUSTER_INVALID_OPERATION + - code: HUB_ELEMENT_ID_NULL_OR_EMPTY + - code: HUB_CLUSTER_OPERATION_SPOKE_SITES_CANNOT_BE_EMPTY + - code: HUB_CLUSTER_OR_STATUS_NOT_FOUND + - code: HUB_CLUSTER_EMPTY + - code: HUB_CLUSTER_ELEMENT_NOT_LOCKED + - code: HUB_ELEMENT_NOT_PRESENT_IN_HUB_CLUSTER + - code: HUB_CLUSTER_DOES_NOT_CATER_TO_SPECIFIED_SPOKE_SITES + - code: HUB_CLUSTER_NEW_HUB_ELEMENT_NOT_FOUND + - code: HUB_CLUSTER_ELEMENT_DOES_NOT_CATER_TO_SPECIFIED_SPOKE_SITES schema: $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete WAN Interface (v2.7) + description: Bad request + summary: Operations Hub Cluster (v4.0) tags: - Site Configuration + /v4.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters/{id}/status: get: - description: Get a specific site wan interface. - operationId: get-v2.7-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + description: Get the state of the hub cluster. + operationId: get-v4.0-api-tenants-tenant_id-sites-site_id-hubclusters-id-status parameters: - description: The tenant ID. in: path @@ -3825,60 +7275,81 @@ paths: schema: description: Site Id type: string - - description: ID of the WAN interface. + - description: ID of the hub cluster. in: path - name: wan_interface_id + name: id required: true schema: - description: Wan Interface Id + description: Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceV2N7' - description: Successful Operation - summary: Get Specific Site WAN Interface (v2.7) + $ref: '#/components/schemas/HubClusterStatusV4' + description: Successful operation + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Hub Cluster not found + summary: Get Hub Cluster Status (v4.0) tags: - Site Configuration - put: - description: Update the site WAN interface. - operationId: put-v2.7-api-tenants-tenant_id-sites-site_id-waninterfaces-wan_interface_id + /v4.1/api/tenants/{tenant_id}/sites: + get: + description: Get Sites of a tenant + operationId: get-v4.1-api-tenants-tenant_id-sites parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: ID of the WAN interface. + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/Site' + type: array + type: object + description: Successful Operation + summary: Get Sites of a tenant (v4.1) + tags: + - Site Configuration + post: + description: Create a new site + operationId: post-v4.1-api-tenants-tenant_id-sites + parameters: + - description: Tenant Id in: path - name: wan_interface_id + name: tenant_id required: true schema: - description: Wan Interface Id + description: Tenant Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceScreenV2N7' + $ref: '#/components/schemas/Site' + description: Details of the site to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceV2N7' + $ref: '#/components/schemas/Site' description: Successful Operation '400': content: @@ -3886,41 +7357,27 @@ paths: example: value: _error: + - code: SITE_ALREADY_EXISTS + - code: SITE_ADMIN_STATE_MISSING + - code: SITE_ROLE_MISSING + - code: INVALID_PRIORITY_POLICYSETSTACK_ID + - code: INVALID_EXTENDED_TAG_SIZE_OR_DUPLICATE + - code: INVALID_NETWORK_POLICYSETSTACK_ID + - code: INVALID_NAT_POLICYSETSTACK_ID - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: WANINTERFACE_CONFIG_INVALID_SITE_ID - - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID - - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH - - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND - - code: WANINTERFACE_CONFIG_INVALID_LABEL - - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED - - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE - - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC - - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP - - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL - - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT - - code: WANINTERFACE_USE_FOR_NON_HUB_PATHS_INVALID - - code: WANINTERFACE_USE_FOR_NON_HUB_PATHS_NOT_ALLOWED + - code: POLICY_NOT_AVAILABLE schema: $ref: '#/components/schemas/Error' description: Bad Request - '404': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Resource Not Found - summary: Update Site WAN Interface (v2.7) + summary: Create a new site (v4.1) tags: - Site Configuration - /v2.7/api/tenants/{tenant_id}/waninterfaces/query: + /v4.1/api/tenants/{tenant_id}/sites/query: post: - description: Queries the DB for Site WAN Interfaces that match the query parameters. - operationId: post-v2.7-api-tenants-tenant_id-waninterfaces-query + description: Queries db for limit number of sites that match query params. + operationId: post-v4.1-api-tenants-tenant_id-sites-query parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true @@ -3931,7 +7388,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceQuery' + $ref: '#/components/schemas/SiteQuery' + description: Query Details for the site responses: '200': content: @@ -3942,7 +7400,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/WANInterfaceQueryFilterV2N7' + $ref: '#/components/schemas/SiteQueryFilter' type: array type: object description: Successful Operation @@ -3952,27 +7410,108 @@ paths: example: value: _error: - - code: BAD_REQUEST + - code: BAD_QUERY_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Site WAN Interfaces (v2.7) + summary: Queries db for limit number of sites that match query params. (v4.1) + tags: + - Site Configuration + /v4.1/api/tenants/{tenant_id}/sites/{site_id}: + delete: + description: Delete a site + operationId: delete-v4.1-api-tenants-tenant_id-sites-site_id + parameters: + - description: Tenant Id + 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 + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Site' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SITE_ALREADY_EXISTS + - code: UNKNOWN_SITE + - 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: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete a site (v4.1) + tags: + - Site Configuration + get: + description: Get Site of a tenant + operationId: get-v4.1-api-tenants-tenant_id-sites-site_id + parameters: + - description: Tenant Id + 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 + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Site' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SITE_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Site of a tenant (v4.1) tags: - Site Configuration - /v3.0/api/tenants/{tenant_id}/sites/{site_id}/admin_state: put: - description: Update an existing site. - operationId: put-v3.0-api-tenants-tenant_id-sites-site_id-admin_state + description: Update an existing site + operationId: put-v4.1-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -3998,35 +7537,34 @@ paths: example: value: _error: - - code: SITE_NOT_FOUND + - code: SITE_ALREADY_EXISTS + - code: SITE_ADMIN_STATE_MISSING + - code: SITE_ROLE_MISSING + - code: INVALID_PRIORITY_POLICYSETSTACK_ID + - code: INVALID_EXTENDED_TAG_SIZE_OR_DUPLICATE + - code: INVALID_NETWORK_POLICYSETSTACK_ID + - code: INVALID_NAT_POLICYSETSTACK_ID - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: SITE_CONFIG_POLICYSET_DOES_NOT_EXIST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update a Site (v3.0) + summary: Update an existing site (v4.1) tags: - Site Configuration - /v3.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters: + /v4.2/api/tenants/{tenant_id}/sites: get: - description: List all the hub clusters. - operationId: get-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters + description: Get Sites of a tenant + operationId: get-v4.2-api-tenants-tenant_id-sites parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string responses: '200': content: @@ -4037,55 +7575,83 @@ paths: - properties: items: items: - $ref: '#/components/schemas/HubCluster' + $ref: '#/components/schemas/SiteV4N2' type: array type: object description: Successful Operation + summary: Get Sites of a tenant (v4.2) + tags: + - Site Configuration + post: + description: Create a new site + operationId: post-v4.2-api-tenants-tenant_id-sites + 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/SiteV4N2' + description: Details of the site to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N2' + description: Successful Operation '400': content: application/json: example: value: _error: - - code: INVALID_VALUE_RANGE - - code: NAME_EXCEEDS_LIMIT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_SITE_CONFIG + - code: POLICY_NOT_AVAILABLE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Hub Clusters (v3.0) + summary: Create a new site (v4.2) tags: - Site Configuration + /v4.2/api/tenants/{tenant_id}/sites/query: post: - description: Creates a new hub cluster. - operationId: post-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters + description: Queries db for limit number of sites that match query params. + operationId: post-v4.2-api-tenants-tenant_id-sites-query parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/HubClusterScreen' - description: Details of the hub cluster to be created + $ref: '#/components/schemas/SiteQuery' + description: Query Details for the site responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubCluster' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SiteQueryFilterV4N2' + type: array + type: object description: Successful Operation '400': content: @@ -4093,47 +7659,38 @@ paths: example: value: _error: - - code: INVALID_VALUE_RANGE - - code: NAME_EXCEEDS_LIMIT + - code: BAD_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Hub Cluster (v3.0) + summary: Queries db for limit number of sites that match query params. (v4.2) tags: - Site Configuration - /v3.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters/{hub_cluster_id}: + /v4.2/api/tenants/{tenant_id}/sites/{site_id}: delete: - description: Delete an existing WAN interface. - operationId: delete-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id + description: Delete a site + operationId: delete-v4.2-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 schema: description: Site Id type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubCluster' + $ref: '#/components/schemas/SiteV4N2' description: Successful Operation '400': content: @@ -4141,45 +7698,43 @@ paths: example: value: _error: - - code: CLUSTER_CONTAINS_CLUSTER_MEMBERS + - code: SITE_NOT_FOUND + - code: UNKNOWN_SITE + - 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: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Hub Cluster (v3.0) + summary: Delete a site (v4.2) tags: - Site Configuration get: - description: List a specific hub cluster. - operationId: get-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id + description: Get Site of a tenant + operationId: get-v4.2-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 schema: description: Site Id type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubCluster' + $ref: '#/components/schemas/SiteV4N2' description: Successful Operation '400': content: @@ -4187,182 +7742,187 @@ paths: example: value: _error: - - code: INVALID_VALUE_RANGE - - code: NAME_EXCEEDS_LIMIT + - code: SITE_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Specific Hub Cluster (v3.0 + summary: Get Site of a tenant (v4.2) tags: - Site Configuration put: - description: Details of the hub cluster to be created. - operationId: put-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id + description: Update an existing site + operationId: put-v4.2-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 schema: description: Site Id type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/HubClusterScreen' - description: Details of the hub cluster to be created + $ref: '#/components/schemas/SiteV4N2' + description: Details of the site to update responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubCluster' + $ref: '#/components/schemas/SiteV4N2' description: Successful Operation - summary: Update Hub Cluster (v3.0) + '400': + content: + application/json: + example: + value: + _error: + - code: SITE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update an existing site (v4.2) tags: - Site Configuration - /v3.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters/{hub_cluster_id}/hubclustermembers: + /v4.3/api/tenants/{tenant_id}/sites: get: - description: List all the hub cluster members. - operationId: get-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers + description: Get Sites of a tenant + operationId: get-v4.3-api-tenants-tenant_id-sites parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - $ref: '#/components/schemas/HubClusterMemberScreen' + $ref: '#/components/schemas/SiteV4N3' type: array type: object description: Successful Operation - summary: Get Hub Cluster Members (v3.0) + summary: Get Sites of a tenant (v4.3) tags: - Site Configuration post: - description: Creates new hub cluster members. - operationId: post-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers + description: Create a new site + operationId: post-v4.3-api-tenants-tenant_id-sites parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: ID of the hub cluster. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N3' + description: Details of the site to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_SITE_CONFIG + - code: POLICY_NOT_AVAILABLE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create a new site (v4.3) + tags: + - Site Configuration + /v4.3/api/tenants/{tenant_id}/sites/query: + post: + description: Queries db for limit number of sites that match query params. + operationId: post-v4.3-api-tenants-tenant_id-sites-query + parameters: + - description: Tenant Id in: path - name: hub_cluster_id + name: tenant_id required: true schema: - description: Hub Cluster Id + description: Tenant Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/HubClusterMemberScreen' - description: Details of the hub cluster member to be created + $ref: '#/components/schemas/SiteQuery' + description: Query Details for the site responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubClusterMemberScreen' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SiteQueryFilterV4N3' + type: array + type: object description: Successful Operation - summary: Creates all Hub Cluster Members (v3.0) + summary: Queries db for limit number of sites that match query params. (v4.3) tags: - Site Configuration - /v3.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters/{hub_cluster_id}/hubclustermembers/{hub_cluster_member_id}: + /v4.3/api/tenants/{tenant_id}/sites/{site_id}: delete: - description: Delete a specific hub cluster member. - operationId: delete-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers-hub_cluster_member_id + description: Delete a site + operationId: delete-v4.3-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 schema: description: Site Id type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string - - description: ID of the hub cluster member. - in: path - name: hub_cluster_member_id - required: true - schema: - description: Hub Cluster Member Id - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubClusterMember' + $ref: '#/components/schemas/SiteV4N3' description: Successful Operation '400': content: @@ -4370,188 +7930,166 @@ paths: example: value: _error: - - code: BAD_REQUEST + - code: SITE_NOT_FOUND + - code: UNKNOWN_SITE + - 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: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Deletes Specific Hub Cluster Member (v3.0) + summary: Delete a site (v4.3) tags: - Site Configuration get: - description: List a specific hub cluster member. - operationId: get-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers-hub_cluster_member_id + description: Get Site of a tenant + operationId: get-v4.3-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 schema: description: Site Id type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string - - description: ID of the hub cluster member. - in: path - name: hub_cluster_member_id - required: true - schema: - description: Hub Cluster Member Id - type: string responses: '200': content: application/json: schema: - items: - $ref: '#/components/schemas/HubClusterMember' - type: array + $ref: '#/components/schemas/SiteV4N3' description: Successful Operation - summary: Get Specific Hub Cluster Member (v3.0) - tags: - - Site Configuration - put: - description: Details of the hub cluster member to be created. - operationId: put-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers-hub_cluster_member_id - parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string - - description: ID of the hub cluster member. - in: path - name: hub_cluster_member_id - required: true - schema: - description: Hub Cluster Member Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/HubClusterMemberScreen' - description: Details of the hub cluster member to be created - responses: - '200': + '400': content: application/json: + example: + value: + _error: + - code: SITE_NOT_FOUND schema: - items: - $ref: '#/components/schemas/HubClusterMemberScreen' - type: array - description: Successful Operation - summary: Update Specific Hub Cluster Member (v3.0) + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Site of a tenant (v4.3) tags: - Site Configuration - ? /v3.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters/{hub_cluster_id}/hubclustermembers/{hub_cluster_member_id}/status - : get: - description: List the state of a specific hub cluster member. - operationId: get-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers-hub_cluster_member_id-status + put: + description: Update an existing site + operationId: put-v4.3-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. - in: path - name: tenant_id - required: true - schema: - description: Tenant Id - type: string - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: ID of the hub cluster. + - description: Tenant Id in: path - name: hub_cluster_id + name: tenant_id required: true schema: - description: Hub Cluster Id + description: Tenant Id type: string - - description: ID of the hub cluster member. + - description: Site Id in: path - name: hub_cluster_member_id + name: site_id required: true schema: - description: Hub Cluster Member Id + description: Site Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N3' + description: Details of the site to update responses: '200': content: application/json: schema: - items: - $ref: '#/components/schemas/HubClusterMember' - type: array + $ref: '#/components/schemas/SiteV4N3' description: Successful Operation - summary: Get Specific Hub Cluster Member State (v3.0) + '400': + content: + application/json: + example: + value: + _error: + - code: POLICY_CONFIG_INVALID_FOR_HUB_SITE + - code: INVALID_SECURITY_POLICYSET + - code: INVALID_POLICY_CONFIGURATION + - code: INVALID_NETWORK_POLICYSETSTACK + - code: DEFAULT_NETWORK_POLICYSETSTACK_NOT_AVAILABLE + - code: INVALID_PRIORITY_POLICYSETSTACK + - code: DEFAULT_PRIORITY_POLICYSETSTACK_NOT_AVAILABLE + - code: POLICYSETSTACK_CONFIG_NOT_SUPPORTED + - code: DEFAULT_POLICY_NOT_CONFIGURED + - code: SITE_CONFIG_SERVICEBINDING_INVALID_FOR_HUB + - code: SITE_CONFIG_SERVICEBINDING_DOES_NOT_EXIST + - code: INVALID_POLICYSET + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update an existing site (v4.3) tags: - Site Configuration - /v3.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters/{hub_cluster_id}/status: + /v4.4/api/tenants/{tenant_id}/sites: get: - description: List the state of a specific hub cluster. - operationId: get-v3.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id-status + description: Get Sites of a tenant + operationId: get-v4.4-api-tenants-tenant_id-sites parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: ID of the hub cluster. + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SiteV4N4' + type: array + type: object + description: Successful Operation + summary: Get Sites of a tenant (v4.4) + tags: + - Site Configuration + post: + description: Create a new site + operationId: post-v4.4-api-tenants-tenant_id-sites + parameters: + - description: Tenant Id in: path - name: hub_cluster_id + name: tenant_id required: true schema: - description: Hub Cluster Id + description: Tenant Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N4' + description: Details of the site to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubCluster' + $ref: '#/components/schemas/SiteV4N4' description: Successful Operation '400': content: @@ -4559,20 +8097,21 @@ paths: example: value: _error: - - code: INVALID_VALUE_RANGE - - code: NAME_EXCEEDS_LIMIT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_SITE_CONFIG + - code: POLICY_NOT_AVAILABLE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Specific Hub Cluster State (v3.0) + summary: Create a new site (v4.4) tags: - Site Configuration - /v4.0/api/tenants/{tenant_id}/hubclusters/query: + /v4.4/api/tenants/{tenant_id}/sites/query: post: - description: Query hub clusters. - operationId: post-v4.0-api-tenants-tenant_id-hubclusters-query + description: Queries db for limit number of sites that match query params. + operationId: post-v4.4-api-tenants-tenant_id-sites-query parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true @@ -4583,8 +8122,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/HubClusterQueryV4' - description: Details of the hub cluster to be created + $ref: '#/components/schemas/SiteQuery' + description: Query Details for the site responses: '200': content: @@ -4595,37 +8134,26 @@ paths: - properties: items: items: - $ref: '#/components/schemas/HubClusterQueryFilterV4' + $ref: '#/components/schemas/SiteQueryFilterV4N4' type: array type: object - description: Successful operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_QUERY_OR_SORT_PARAMETERS - schema: - $ref: '#/components/schemas/Error' - description: Bad request - summary: Query Hub Clusters (v4.0) + description: Successful Operation + summary: Queries db for limit number of sites that match query params. (v4.4) tags: - Site Configuration - /v4.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters: - get: - description: List all the hub clusters. - operationId: get-v4.0-api-tenants-tenant_id-sites-site_id-hubclusters + /v4.4/api/tenants/{tenant_id}/sites/{site_id}: + delete: + description: Delete a site + operationId: delete-v4.4-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -4637,344 +8165,374 @@ paths: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/HubClusterV4' - type: array - type: object - description: Successful operation - summary: Get Hub Clusters (v4.0) + $ref: '#/components/schemas/SiteV4N4' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SITE_NOT_FOUND + - code: UNKNOWN_SITE + - 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: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete a site (v4.4) tags: - Site Configuration - post: - description: Create a hub cluster. - operationId: post-v4.0-api-tenants-tenant_id-sites-site_id-hubclusters + get: + description: Get Site of a tenant + operationId: get-v4.4-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 schema: description: Site Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/HubClusterV4' - description: Details of the hub cluster to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubClusterV4' - description: Successful operation + $ref: '#/components/schemas/SiteV4N4' + description: Successful Operation '400': content: application/json: example: value: _error: - - code: HUB_CLUSTER_NAME_NULL_OR_EMPTY - - code: HUB_CLUSTER_NAME_EXCEEDS_LIMIT - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_TAG - - code: INVALID_HUB_SITE - - code: HUB_CLUSTER_ELEMENT_PRESENT - - code: DEFAULT_HUB_CLUSTER_EXISTS - - code: HUB_CLUSTER_NAME_NOT_UNIQUE - - code: HUB_CLUSTER_COUNT_IN_HUB_SITE_EXCEEDED - - code: DUPLICATE_SPOKE_SITES_PRESENT - - code: INVALID_PEER_SITES_PRESENT - - code: SOME_SPOKE_SITES_ALREADY_MAPPED_TO_ANOTHER_CLUSTER - - code: INVALID_VALUE_RANGE + - code: SITE_NOT_FOUND schema: $ref: '#/components/schemas/Error' - description: Bad request - summary: Create Hub Cluster (v4.0) + description: Bad Request + summary: Get Site of a tenant (v4.4) tags: - Site Configuration - /v4.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters/{hub_cluster_id}: - delete: - description: Delete a hub cluster. - operationId: delete-v4.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id + put: + description: Update an existing site + operationId: put-v4.4-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 schema: description: Site Id type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N4' + description: Details of the site to update responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubClusterV4' - description: Successful operation + $ref: '#/components/schemas/SiteV4N4' + description: Successful Operation '400': content: application/json: example: value: _error: - - code: HUB_CLUSTER_NOT_FOUND - - code: HUB_CLUSTER_HAS_ELEMENTS + - code: POLICY_CONFIG_INVALID_FOR_HUB_SITE + - code: INVALID_SECURITY_POLICYSET + - code: INVALID_POLICY_CONFIGURATION + - code: INVALID_NETWORK_POLICYSETSTACK + - code: DEFAULT_NETWORK_POLICYSETSTACK_NOT_AVAILABLE + - code: INVALID_PRIORITY_POLICYSETSTACK + - code: DEFAULT_PRIORITY_POLICYSETSTACK_NOT_AVAILABLE + - code: POLICYSETSTACK_CONFIG_NOT_SUPPORTED + - code: DEFAULT_POLICY_NOT_CONFIGURED + - code: SITE_CONFIG_SERVICEBINDING_INVALID_FOR_HUB + - code: SITE_CONFIG_SERVICEBINDING_DOES_NOT_EXIST + - code: INVALID_POLICYSET + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH schema: $ref: '#/components/schemas/Error' - description: Bad request - summary: Delete Hub Cluster (v4.0) + description: Bad Request + summary: Update an existing site (v4.4) tags: - Site Configuration + /v4.5/api/tenants/{tenant_id}/sites: get: - description: List a specific hub cluster. - operationId: get-v4.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id + description: Get Sites of a tenant + operationId: get-v4.5-api-tenants-tenant_id-sites parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: ID of the hub cluster. + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SiteV4N5' + type: array + type: object + description: Successful Operation + summary: Get Sites of a tenant (v4.5) + tags: + - Site Configuration + post: + description: Create a new site + operationId: post-v4.5-api-tenants-tenant_id-sites + parameters: + - description: Tenant Id in: path - name: hub_cluster_id + name: tenant_id required: true schema: - description: Hub Cluster Id + description: Tenant Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N5' + description: Details of the site to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubClusterV4' - description: Successful operation - '404': + $ref: '#/components/schemas/SiteV4N5' + description: Successful Operation + '400': content: application/json: example: value: _error: - - code: HUB_CLUSTER_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_SITE_CONFIG + - code: POLICY_NOT_AVAILABLE + - code: SITE_STATE_INVALID schema: $ref: '#/components/schemas/Error' - description: Hub cluster not found - summary: Get Specific Hub Cluster (v4.0) + description: Bad Request + summary: Create a new site (v4.5) tags: - Site Configuration - put: - description: Update the hub cluster. - operationId: put-v4.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id + /v4.5/api/tenants/{tenant_id}/sites/query: + post: + description: Queries db for limit number of sites that match query params. + operationId: post-v4.5-api-tenants-tenant_id-sites-query parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. + 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: Queries db for limit number of sites that match query params. (v4.5) + tags: + - Site Configuration + /v4.5/api/tenants/{tenant_id}/sites/{site_id}: + delete: + description: Delete a site + operationId: delete-v4.5-api-tenants-tenant_id-sites-site_id + parameters: + - description: Tenant Id in: path - name: site_id + name: tenant_id required: true schema: - description: Site Id + description: Tenant Id type: string - - description: ID of the hub cluster. + - description: Site Id in: path - name: hub_cluster_id + name: site_id required: true schema: - description: Hub Cluster Id + description: Site Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/HubClusterV4' - description: Details of the hub cluster to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubClusterV4' - description: Successful operation + $ref: '#/components/schemas/SiteV4N5' + description: Successful Operation '400': content: application/json: example: value: _error: - - code: HUB_CLUSTER_NAME_NULL_OR_EMPTY - - code: HUB_CLUSTER_NAME_EXCEEDS_LIMIT - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_TAG - - code: HUB_CLUSTER_NOT_FOUND - - code: DEFAULT_HUB_CLUSTER_EXISTS - - code: HUB_CLUSTER_NAME_NOT_UNIQUE - - code: HUB_CLUSTER_INVALID_ELEMENTS_INFO - - code: DUPLICATE_SPOKE_SITES_PRESENT - - code: INVALID_PEER_SITES_PRESENT - - code: SOME_SPOKE_SITES_ALREADY_MAPPED_TO_ANOTHER_CLUSTER - - code: HUB_CLUSTER_UNDER_MAINTENANCE - - code: HUB_CLUSTER_STATUS_NOT_FOUND + - code: SITE_NOT_FOUND + - code: UNKNOWN_SITE + - 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: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS schema: $ref: '#/components/schemas/Error' - description: Bad request - summary: Update Hub Cluster (v4.0) + description: Bad Request + summary: Delete a site (v4.5) tags: - Site Configuration - /v4.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters/{hub_cluster_id}/operations: - post: - description: Operations to be performed on the hub cluster. - operationId: post-v4.0-api-tenants-tenant_id-sites-site_id-hubclusters-hub_cluster_id-operations + get: + description: Get Site of a tenant + operationId: get-v4.5-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 schema: description: Site Id type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/HubClusterOperationV4' - description: Details of the operations to be performed on the hub cluster. responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubClusterStatusV4' - description: Successful operation + $ref: '#/components/schemas/SiteV4N5' + description: Successful Operation '400': content: application/json: example: value: _error: - - code: HUB_CLUSTER_INVALID_OPERATION - - code: HUB_ELEMENT_ID_NULL_OR_EMPTY - - code: HUB_CLUSTER_OPERATION_SPOKE_SITES_CANNOT_BE_EMPTY - - code: HUB_CLUSTER_OR_STATUS_NOT_FOUND - - code: HUB_CLUSTER_EMPTY - - code: HUB_CLUSTER_ELEMENT_NOT_LOCKED - - code: HUB_ELEMENT_NOT_PRESENT_IN_HUB_CLUSTER - - code: HUB_CLUSTER_DOES_NOT_CATER_TO_SPECIFIED_SPOKE_SITES - - code: HUB_CLUSTER_NEW_HUB_ELEMENT_NOT_FOUND - - code: HUB_CLUSTER_ELEMENT_DOES_NOT_CATER_TO_SPECIFIED_SPOKE_SITES + - code: SITE_NOT_FOUND schema: $ref: '#/components/schemas/Error' - description: Bad request - summary: Operations Hub Cluster (v4.0) + description: Bad Request + summary: Get Site of a tenant (v4.5) tags: - Site Configuration - /v4.0/api/tenants/{tenant_id}/sites/{site_id}/hubclusters/{id}/status: - get: - description: Get the state of the hub cluster. - operationId: get-v4.0-api-tenants-tenant_id-sites-site_id-hubclusters-id-status + put: + description: Update an existing site + operationId: put-v4.5-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 schema: description: Site Id type: string - - description: ID of the hub cluster. - in: path - name: id - required: true - schema: - description: Id - type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N5' + description: Details of the site to update responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubClusterStatusV4' - description: Successful operation - '404': + $ref: '#/components/schemas/SiteV4N5' + description: Successful Operation + '400': content: application/json: + example: + value: + _error: + - code: POLICY_CONFIG_INVALID_FOR_HUB_SITE + - code: INVALID_SECURITY_POLICYSET + - code: INVALID_POLICY_CONFIGURATION + - code: INVALID_NETWORK_POLICYSETSTACK + - code: DEFAULT_NETWORK_POLICYSETSTACK_NOT_AVAILABLE + - code: INVALID_PRIORITY_POLICYSETSTACK + - code: DEFAULT_PRIORITY_POLICYSETSTACK_NOT_AVAILABLE + - code: POLICYSETSTACK_CONFIG_NOT_SUPPORTED + - code: DEFAULT_POLICY_NOT_CONFIGURED + - code: SITE_CONFIG_SERVICEBINDING_INVALID_FOR_HUB + - code: SITE_CONFIG_SERVICEBINDING_DOES_NOT_EXIST + - code: SITE_STATE_INVALID + - code: SITE_ELEMENT_CLUSTER_ROLE_UPDATE_NOT_ALLOWED + - code: INVALID_POLICYSET + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH schema: $ref: '#/components/schemas/Error' - description: Hub Cluster not found - summary: Get Hub Cluster Status (v4.0) + description: Bad Request + summary: Update an existing site (v4.5) tags: - Site Configuration - /v4.8/api/tenants/{tenant_id}/sites: + /v4.6/api/tenants/{tenant_id}/sites: get: - description: Get all the sites of a tenant. - operationId: get-v4.8-api-tenants-tenant_id-sites + description: Get all sites of a tenant + operationId: get-v4.6-api-tenants-tenant_id-sites parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true @@ -4987,22 +8545,22 @@ paths: application/json: schema: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - $ref: '#/components/schemas/SiteV4N8' + $ref: '#/components/schemas/SiteV4N6' type: array type: object description: Successful Operation - summary: Get Sites of a Tenant (v4.8) + summary: Get all sites of a tenant (v4.6) tags: - Site Configuration post: - description: Create a new site. - operationId: post-v4.8-api-tenants-tenant_id-sites + description: Create a new v4.5 site + operationId: post-v4.6-api-tenants-tenant_id-sites parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true @@ -5013,14 +8571,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteScreenV4N8' + $ref: '#/components/schemas/SiteV4N6' description: Details of the site to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteV4N8' + $ref: '#/components/schemas/SiteV4N6' description: Successful Operation '400': content: @@ -5033,62 +8591,25 @@ 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.8) - tags: - - Site Configuration - /v4.8/api/tenants/{tenant_id}/sites/query: - post: - 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 - 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/SiteQueryFilterV4N8' - type: array - type: object - description: Successful Operation - summary: Query DB for Number of Sites that Match Query Params (v4.8) + summary: Create a new v4.5 site (v4.6) tags: - Site Configuration - /v4.8/api/tenants/{tenant_id}/sites/{site_id}: + /v4.6/api/tenants/{tenant_id}/sites/{site_id}: delete: - description: Delete a particular site. - operationId: delete-v4.8-api-tenants-tenant_id-sites-site_id + description: Delete a site + operationId: delete-v4.6-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -5100,7 +8621,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N8' + $ref: '#/components/schemas/SiteV4N6' description: Successful Operation '400': content: @@ -5113,27 +8634,26 @@ paths: - code: DELETE_FORBIDDEN_INVALID_STATE - code: DELETE_FORBIDDEN_SITE_WAN_EXISTS - code: DELETE_FORBIDDEN_SITE_WAN_LQM_CONFIG_EXISTS - - code: DELETE_FORBIDDEN_ELEMENT_OR_ELEMENT_SHELL_EXISTS + - code: DELETE_FORBIDDEN_ELEMENT_EXISTS - code: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete a Site (v4.8) + summary: Delete a site (v4.6) tags: - Site Configuration get: - description: Get the site if a particular tenant. - operationId: get-v4.8-api-tenants-tenant_id-sites-site_id + description: Get Site of a tenant by tenant ID and its ID + operationId: get-v4.6-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -5145,7 +8665,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N8' + $ref: '#/components/schemas/SiteV4N6' description: Successful Operation '400': content: @@ -5157,22 +8677,21 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Site of Tenant (v4.8) + summary: Get Site of a tenant by tenant ID and its ID (v4.6) tags: - Site Configuration put: - description: Update an existing site. - operationId: put-v4.8-api-tenants-tenant_id-sites-site_id + description: Update an existing v4.6 site + operationId: put-v4.6-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -5183,14 +8702,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteScreenV4N8' + $ref: '#/components/schemas/SiteV4N6' description: Details of the site to update responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteV4N8' + $ref: '#/components/schemas/SiteV4N6' description: Successful Operation '400': content: @@ -5215,19 +8734,18 @@ 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.8) + summary: Update an existing v4.6 site (v4.6) tags: - Site Configuration - /v4.9/api/tenants/{tenant_id}/sites: + /v4.7/api/tenants/{tenant_id}/sites: get: - description: Get all the sites of a tenant. - operationId: get-v4.9-api-tenants-tenant_id-sites + description: Get all sites of a tenant + operationId: get-v4.7-api-tenants-tenant_id-sites parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true @@ -5244,18 +8762,18 @@ paths: - properties: items: items: - $ref: '#/components/schemas/SiteV4N9' + $ref: '#/components/schemas/SiteV4N7' type: array type: object description: Successful Operation - summary: Get Sites of a Tenant (v4.9) + summary: Get all sites of a tenant (v4.7) tags: - Site Configuration post: - description: Create a new site. - operationId: post-v4.9-api-tenants-tenant_id-sites + description: Create a site + operationId: post-v4.7-api-tenants-tenant_id-sites parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true @@ -5266,14 +8784,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N9' + $ref: '#/components/schemas/SiteV4N7' description: Details of the site to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteScreenV4N9' + $ref: '#/components/schemas/SiteV4N7' description: Successful Operation '400': content: @@ -5287,65 +8805,25 @@ 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.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) + summary: Create a site (v4.7) tags: - Site Configuration - /v4.9/api/tenants/{tenant_id}/sites/{site_id}: + /v4.7/api/tenants/{tenant_id}/sites/{site_id}: delete: - description: Delete a particular site. - operationId: delete-v4.9-api-tenants-tenant_id-sites-site_id + description: Delete a site + operationId: delete-v4.7-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -5357,7 +8835,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N9' + $ref: '#/components/schemas/SiteV4N7' description: Successful Operation '400': content: @@ -5370,27 +8848,26 @@ paths: - code: DELETE_FORBIDDEN_INVALID_STATE - code: DELETE_FORBIDDEN_SITE_WAN_EXISTS - code: DELETE_FORBIDDEN_SITE_WAN_LQM_CONFIG_EXISTS - - code: DELETE_FORBIDDEN_ELEMENT_OR_ELEMENT_SHELL_EXISTS + - code: DELETE_FORBIDDEN_ELEMENT_EXISTS - code: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete a Site (v4.9) + summary: Delete a site (v4.7) tags: - Site Configuration get: - description: Get the site if a particular tenant. - operationId: get-v4.9-api-tenants-tenant_id-sites-site_id + description: Get Site of a tenant by tenant ID and its ID + operationId: get-v4.7-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -5402,7 +8879,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N9' + $ref: '#/components/schemas/SiteV4N7' description: Successful Operation '400': content: @@ -5414,22 +8891,21 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Site of Tenant (v4.9) + summary: Get Site of a tenant by tenant ID and its ID (v4.7) tags: - Site Configuration put: - description: Update an existing site. - operationId: put-v4.9-api-tenants-tenant_id-sites-site_id + description: Update an existing site + operationId: put-v4.7-api-tenants-tenant_id-sites-site_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - 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 @@ -5440,14 +8916,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteScreenV4N9' + $ref: '#/components/schemas/SiteV4N7' description: Details of the site to update responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteV4N9' + $ref: '#/components/schemas/SiteV4N7' description: Successful Operation '400': content: @@ -5473,14 +8949,10 @@ 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.9) + summary: Update an existing site (v4.7) tags: - Site Configuration servers: diff --git a/openapi-specs/sdwan/legacy/SoftwareManagement.yaml b/openapi-specs/sdwan/legacy/SoftwareManagement.yaml index 9b6d9d144..e0b5f327e 100644 --- a/openapi-specs/sdwan/legacy/SoftwareManagement.yaml +++ b/openapi-specs/sdwan/legacy/SoftwareManagement.yaml @@ -2,21 +2,9 @@ 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: @@ -26,28 +14,6 @@ components: - 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 BulkResponse: properties: count: @@ -64,6 +30,22 @@ components: type: description: "The type. \n" type: string + ElementImage: + properties: + id: + description: "The ID of the device images.\t\n" + type: string + release_url: + description: 'The release URL. + + ' + type: string + state: + description: "The device connection state. \n" + type: string + version: + description: "The software version installed. \n" + type: string ElementImageV2N1: properties: fips_certification_valid: @@ -429,10 +411,14 @@ components: ModelSoftwareMap: properties: bundle_name: - description: Bundle Name + description: 'The software bundle name. + + ' type: string model: - description: Model + description: 'The software model. + + ' type: string SoftwareDownloadHistoryQuery: properties: @@ -512,6 +498,64 @@ info: version: Latest openapi: 3.0.0 paths: + /v2.0/api/tenants/{tenant_id}/element_images: + get: + description: Get existing machine images + operationId: get-v2.0-api-tenants-tenant_id-element_images + parameters: + - description: 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/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementImageV2N1' + type: array + type: object + description: Successful Operation + summary: Get existing machine images (v2.0) + tags: + - Software Management + /v2.0/api/tenants/{tenant_id}/element_images/{machine_image_id}: + get: + description: Get information about a machine image + operationId: get-v2.0-api-tenants-tenant_id-element_images-machine_image_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Machine Image Id + in: path + name: machine_image_id + required: true + schema: + description: Machine Image Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementImage' + description: Successful Operation + summary: Get information about a machine image (v2.0) + tags: + - Software Management /v2.0/api/tenants/{tenant_id}/machine_upgrade/query: post: description: Query the configuration of the machine upgrade. diff --git a/openapi-specs/sdwan/legacy/SystemAdministration.yaml b/openapi-specs/sdwan/legacy/SystemAdministration.yaml index b4dac1cd2..35bc6fc58 100644 --- a/openapi-specs/sdwan/legacy/SystemAdministration.yaml +++ b/openapi-specs/sdwan/legacy/SystemAdministration.yaml @@ -612,7 +612,6 @@ components: - SUPER - READONLY - MONITOR - - EVAL type: string tenant_id: description: 'ID of the tenant. @@ -649,7 +648,6 @@ components: - SUPER - READONLY - MONITOR - - EVAL type: string tenant_id: description: 'ID of the tenant. @@ -698,7 +696,6 @@ components: - SUPER - READONLY - MONITOR - - EVAL type: string tenant_id: description: 'ID of the tenant. @@ -816,6 +813,213 @@ components: ' type: string + Idp: + properties: + auto_provision_operators: + description: "The option Auto Create Operators is selected. True or False.\ + \ \n" + type: boolean + auto_provision_roles: + description: "The option Auto Create Operator Roles is selected. True or\ + \ False. \n" + type: boolean + disabled: + description: "List the disabled IdP configurations. \n" + type: boolean + disabled_reason: + description: 'List the reasons for disabled IdP configurations. + + ' + type: string + id: + description: 'The ID. + + ' + type: string + idp_domain_admin_email: + description: 'The entered email ID of the Palo Alto Networks Customer Support. + + ' + type: string + idp_domains: + description: 'The configured IdP domain name. Max length = 128. Consisting + of letters all in lower case and numbers only. + + ' + items: + description: Idp Domains + type: string + type: array + idp_entity_id: + description: 'The IdP identity provider ID. + + ' + type: string + idp_login_url: + description: 'The IdP login URL. + + ' + type: string + idp_logout_url: + description: 'The IdP log out URL. + + ' + type: string + idp_metadata_b64: + description: 'The IdP metadata b64. + + ' + type: string + inactive: + description: 'List the inactive IdP configurations. + + ' + type: boolean + inactive_reason: + description: 'The reason for the IdP configuration being inactive. + + ' + type: string + role_map: + description: 'Role mapping as defined in the IdP system. + + ' + type: object + session_timeout_s: + description: 'The session timeout duration for a session in seconds. The + default value is 3600 seconds. + + ' + format: int32 + type: integer + sp_metadata_b64: + description: 'The SP metadata b64. + + ' + type: string + sp_x509_b64: + description: 'sp_x509_b64. + + ' + type: string + sp_x509_serial_no: + description: 'The SP x509 serial number. Max length = 1024. + + ' + type: string + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + type: string + required: + - idp_entity_id + - idp_domain_admin_email + - tenant_id + IdpV3N1: + properties: + auto_provision_operators: + description: "The option Auto Create Operators is selected. True or False.\ + \ \n" + type: boolean + auto_provision_roles: + description: "The option Auto Create Operator Roles is selected. True or\ + \ False. \n" + type: boolean + disabled: + description: "List the disabled IdP configurations. \n" + type: boolean + disabled_reason: + description: 'List the reasons for disabled IdP configurations. + + ' + type: string + id: + description: 'The ID. + + ' + type: string + idp_domain_admin_email: + description: 'The entered email ID of the Palo Alto Networks Customer Support. + + ' + type: string + idp_domains: + description: 'The configured IdP domain name. Max length = 128. Consisting + of letters all in lower case and numbers only. + + ' + items: + description: Idp Domains + type: string + type: array + idp_entity_id: + description: 'The IdP identity provider ID. + + ' + type: string + idp_login_url: + description: 'The IdP login URL. + + ' + type: string + idp_logout_url: + description: 'The IdP log out URL. + + ' + type: string + idp_metadata_b64: + description: 'The IdP metadata b64. + + ' + type: string + inactive: + description: 'List the inactive IdP configurations. + + ' + type: boolean + inactive_reason: + description: 'The reason for the IdP configuration being inactive. + + ' + type: string + role_map: + description: 'Role mapping as defined in the IdP system. + + ' + type: object + session_timeout_s: + description: 'The session timeout duration for a session in seconds. The + default value is 3600 seconds. + + ' + format: int32 + type: integer + sign_redirect_binding: + description: 'The sign redirect binding is true or false. + + ' + type: boolean + sp_metadata_b64: + description: 'The SP metadata b64. + + ' + type: string + sp_x509_b64: + description: 'sp_x509_b64. + + ' + type: string + sp_x509_serial_no: + description: 'The SP x509 serial number. Max length = 1024. + + ' + type: string + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + type: string + required: + - idp_entity_id + - idp_domain_admin_email + - tenant_id IdpV3N2: properties: auto_provision_operators: @@ -1190,8 +1394,6 @@ components: ' type: string - MigrationState: - properties: {} Operator: properties: addresses: @@ -1225,12 +1427,6 @@ components: ' 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) ' - type: string email_validated: description: 'Validate the email ID. @@ -1299,9 +1495,6 @@ components: items: $ref: '#/components/schemas/LinkedAccount' type: array - migration_state: - $ref: '#/components/schemas/MigrationState' - description: Migration State name: description: "The name. \n" type: string @@ -1488,193 +1681,33 @@ components: - first_name - email - tenant_id - OperatorV2N2: + PasswordChange: properties: - addresses: - description: 'The list of operator addresses. Max number of addresses = - 20. - - ' - items: - $ref: '#/components/schemas/Address' - type: array - custom_roles: - description: "The list/details of the custom roles. \n" - items: - $ref: '#/components/schemas/CustomRoleV2N1' - type: array - disable_idp_login: - description: "Lists if the tenant IdP log in option is disabled. \n" - type: boolean - disabled: - description: 'List the disabled tenants. - - ' - type: boolean - disabled_reason: - description: 'The reason for disabling the tenant. + oldPassword: + description: 'The old password. Max length = 1000. ' type: string - email: - description: 'The operator email ID. - - ' + password: + description: "The new password. Max length = 1000. \n" type: string - email_iam: - description: 'The operator email IAM ID. + repeatPassword: + description: 'Repeat the new password. Max length = 1000. ' type: string - email_validated: - description: 'Validate the email ID. + required: + - repeatPassword + - password + PasswordPolicy: + properties: + enable_failed_login_attempts: + description: 'The failed login attempts is enabled. ' type: boolean - enable_session_ip_lock: - description: "Enable the sessin IP lock. \n" - type: boolean - first_name: - description: 'The first name of the operator. Max size = 100. - - ' - type: string - from_esp: - description: 'If the tenant is ESP. - - ' - type: boolean - from_esp_name: - description: 'The name of the ESP tenant. Max size = 512. - - ' - type: string - from_esp_tenant_id: - description: 'The ESP tenant ID. - - ' - type: string - id: - description: 'The ID. - - ' - type: string - inactive: - description: 'List the inactive tenants. - - ' - type: boolean - inactive_reason: - description: "The reason for the tenant being inactive. \n" - type: string - ipv4_list: - description: 'The list of IPv4 addresses. - - ' - items: - $ref: '#/components/schemas/IPv4Address' - type: array - is_locked: - description: 'Locked. True or False. - - ' - type: boolean - 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: 'The last name of the ESP tenant. - - ' - type: string - linked_accounts: - 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: 'The migration state. - - ' - phone_numbers: - description: 'The details of the phone numbers. Maximum of twenty phones - can be specified. - - ' - items: - $ref: '#/components/schemas/PhoneNumber' - type: array - region: - description: 'The region of the tenant. - - ' - type: string - roles: - description: "The defined ESP roles. \n" - items: - $ref: '#/components/schemas/AuthRole' - type: array - secondary_emails: - description: 'List of secondary email addresses. Max size = 20. - - ' - items: - $ref: '#/components/schemas/Email' - type: array - settings: - description: 'The operator settings. - - ' - type: string - tenant_id: - description: 'ID of the tenant. - - ' - type: string - required: - - linked_accounts - - first_name - - email - - tenant_id - PasswordChange: - properties: - oldPassword: - description: 'The old password. Max length = 1000. - - ' - type: string - password: - description: "The new password. Max length = 1000. \n" - type: string - repeatPassword: - description: 'Repeat the new password. Max length = 1000. - - ' - type: string - required: - - repeatPassword - - password - PasswordPolicy: - properties: - enable_failed_login_attempts: - description: 'The failed login attempts is enabled. - - ' - type: boolean - enable_failed_login_time_delay: - description: "The failed log in time delay is enabled. \n" + enable_failed_login_time_delay: + description: "The failed log in time delay is enabled. \n" type: boolean enable_maximum_password_length: description: 'The maximum password length is enabled. @@ -1914,41 +1947,6 @@ 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: @@ -2239,12 +2237,9 @@ 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 - TenantV2N5: + TenantV2N1: properties: address: $ref: '#/components/schemas/Address' @@ -2260,11 +2255,6 @@ components: description: Clients type: string type: array - csp_tenant_id: - description: 'The CSP tenant ID. Max length = 32. - - ' - type: string description: description: 'The description of the tenant. Max size = 1024. @@ -2302,9 +2292,6 @@ components: ' type: boolean - is_pa_iot_security_license: - description: Is Pa Iot Security License - type: boolean is_support: description: Is Support type: boolean @@ -2340,11 +2327,6 @@ components: items: $ref: '#/components/schemas/PhoneNumber' type: array - prisma_access_tenant_id: - description: 'The prisma access tenant ID. Max size = 32. - - ' - type: string provider_data: description: 'The details of the provider data. @@ -2355,41 +2337,17 @@ components: region: description: 'The region of the tenant. - ' - type: string - sase_at: - description: 'The sase date. - - ' - format: date - type: string - telemetry_region: - description: 'The telemetry region. - ' type: string tenant_id: - description: "ID of the tenant. \n" - type: string - tsg_id: - description: 'The tenant TSG ID. + description: 'The ID of the tenant. ' type: string - tsg_instances: - description: 'The details of the TSG instances. - - ' - items: - $ref: '#/components/schemas/TsgInstance' - type: array required: - tenant_id - TenantV2N7: + TenantV2N2: properties: - ? '' - : description: X Panw Region - type: string address: $ref: '#/components/schemas/Address' description: 'The address of the site. @@ -2404,11 +2362,6 @@ components: description: Clients type: string type: array - csp_tenant_id: - description: 'The CSP tenant ID. Max length = 32. - - ' - type: string description: description: 'The description of the tenant. Max size = 1024. @@ -2444,22 +2397,10 @@ 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: 'True or False for support. - - ' + description: Is Support type: boolean name: description: 'The name of the tenant. Max size = 512. @@ -2510,75 +2451,157 @@ components: ' type: string - sase_at: - description: 'The sase date. - - ' - format: date - type: string - telemetry_region: - description: 'The telemetry region. + tenant_id: + description: 'The ID of the tenant. ' type: string - tenant_id: - description: 'ID of the tenant. + required: + - tenant_id + TenantV2N3: + properties: + address: + $ref: '#/components/schemas/Address' + description: 'The address of the site. ' + canonical_name: + description: "The tenant canonical name. Max size = 128. \n" type: string - tsg_id: - description: 'The tenant TSG ID. + clients: + description: "The client tenant. \n" + items: + description: Clients + type: string + type: array + csp_tenant_id: + description: 'The CSP tenant ID. Max length = 32. ' type: string - tsg_instances: - description: 'The details of the TSG instances. + description: + description: 'The description of the tenant. Max size = 1024. ' - items: - $ref: '#/components/schemas/TsgInstance' - type: array - required: - - tenant_id - Token: - properties: - oldPassword: - description: 'The old password. Max length = 1000. + disabled: + description: 'List the disabled tenants. ' type: string - password: - description: "The new password. Max length = 1000. \n" - type: string - repeatPassword: - description: 'Repeat the new password. Max length = 1000. + disabled_reason: + description: 'The reason for disabling the tenant. ' 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. + id: + description: 'The ID. ' type: string - region: - description: 'The region of the TSG instance. + inactive: + description: 'List the inactive tenants. ' type: string - tenant_id: - description: Tenant Id + inactive_reason: + description: "The reason for the tenant being inactive. \n" type: string - Type: - properties: - value: + ipv4_list: + description: "The list of IPv4 addresses. \n" + items: + $ref: '#/components/schemas/IPv4Address' + type: array + is_esp: + description: 'If the tenant is ESP. + + ' + type: boolean + is_support: + description: Is Support + type: boolean + name: + description: 'The name of the tenant. Max size = 512. + + ' + type: string + operator: + $ref: '#/components/schemas/Operator' + description: 'The details of the operator. + + ' + pan_account_id: + description: 'The tenant PAN CSP account ID. Max size = 32. + + ' + type: string + pan_tenant_id: + description: 'The PAN tenant ID. Max size = 32. + + ' + type: string + password_policy: + $ref: '#/components/schemas/PasswordPolicy' + description: 'The details of the password policy. + + ' + phone_numbers: + description: 'The details of the phone numbers. + + ' + items: + $ref: '#/components/schemas/PhoneNumber' + type: array + prisma_access_tenant_id: + description: 'The prisma access tenant ID. Max size = 32. + + ' + type: string + provider_data: + description: 'The details of the provider data. + + ' + items: + $ref: '#/components/schemas/ProviderData' + type: array + region: + description: 'The region of the tenant. + + ' + type: string + telemetry_region: + description: 'The telemetry region. + + ' + type: string + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + type: string + required: + - tenant_id + Token: + properties: + oldPassword: + description: 'The old password. Max length = 1000. + + ' + type: string + 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 + Type: + properties: + value: description: Value type: string UserAgent: @@ -2808,6 +2831,120 @@ paths: summary: Logout for MSP client (v2.0) tags: - System Administration + /v2.0/api/tenants/{tenant_id}: + get: + description: Get tenant details for tenant id + operationId: get-v2.0-api-tenants-tenant_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get tenant details for tenant id (v2.0) + tags: + - System Administration + patch: + description: Patch tenant + operationId: patch-v2.0-api-tenants-tenant_id + 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/Tenant' + description: Tenant details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: OPERATOR_INVALID_ETAG + - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Patch tenant (v2.0) + tags: + - System Administration + put: + description: Update tenant + operationId: put-v2.0-api-tenants-tenant_id + 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/Tenant' + description: Tenant details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: OPERATOR_INVALID_ETAG + - code: TENANT_INVALID_CANONICAL_NAME_CHANGE + - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update tenant (v2.0) + tags: + - System Administration /v2.0/api/tenants/{tenant_id}/accounts/password/change: post: description: Allows a user to change a password. @@ -2869,6 +3006,43 @@ paths: summary: Get API Versions (v2.0) tags: - System Administration + patch: + description: Patch api versions + operationId: patch-v2.0-api-tenants-tenant_id-api_versions + 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/ApiVersions' + description: Tenant details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ApiVersions' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: OPERATOR_INVALID_ETAG + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Patch api versions (v2.0) + tags: + - System Administration put: description: Update the set of available API versions. operationId: put-v2.0-api-tenants-tenant_id-api_versions @@ -3891,10 +4065,10 @@ paths: summary: Forgot Password for Tenant Operator (v2.0) tags: - System Administration - /v2.0/api/tenants/{tenant_id}/operators/{operator_id}/authtokens: + /v2.0/api/tenants/{tenant_id}/operators: get: - description: List all the auth tokens. - operationId: get-v2.0-api-tenants-tenant_id-operators-operator_id-authtokens + description: Get a list of tenant operators. + operationId: get-v2.0-api-tenants-tenant_id-operators parameters: - description: The tenant ID. in: path @@ -3903,13 +4077,6 @@ paths: schema: description: Tenant Id type: string - - description: The operator ID. - in: path - name: operator_id - required: true - schema: - description: Operator Id - type: string responses: '200': content: @@ -3920,16 +4087,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/AuthToken' + $ref: '#/components/schemas/OperatorV2N1' type: array type: object description: Successful Operation - summary: Get Auth Tokens (v2.0) + summary: Get Tenant Operators (v2.0) tags: - System Administration post: - description: Create an auth token. - operationId: post-v2.0-api-tenants-tenant_id-operators-operator_id-authtokens + description: Create a tenant operator. + operationId: post-v2.0-api-tenants-tenant_id-operators parameters: - description: The tenant ID. in: path @@ -3938,25 +4105,18 @@ paths: schema: description: Tenant Id type: string - - description: The operator ID. - in: path - name: operator_id - required: true - schema: - description: Operator Id - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/AuthToken' - description: Auth token details + $ref: '#/components/schemas/OperatorV2N1' + description: Operator details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/AuthToken' + $ref: '#/components/schemas/OperatorV2N1' description: Successful Operation '400': content: @@ -3964,7 +4124,256 @@ paths: example: value: _error: - - code: TOKEN_INVALID_SESSION_DATA + - code: BAD_REQUEST + - code: SESSION_SUBJECT_NOT_FOUND + - code: OPERATOR_INVALID_OPERATOR_EMAIL + - code: OPERATOR_INVALID_SIGNUP_ROLE + - code: OPERATOR_INVALID_SUBJECT_TENANT_ID + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Tenant Operator (v2.0) + tags: + - System Administration + /v2.0/api/tenants/{tenant_id}/operators/{operator_id}: + delete: + description: Delete a specific tenant operator. + operationId: delete-v2.0-api-tenants-tenant_id-operators-operator_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The operator ID. + in: path + name: operator_id + required: true + schema: + description: Operator Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OperatorV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: OPERATOR_INSUFFICIENT_OPERATOR_PERMISSIONS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Tenant Operator (v2.0) + tags: + - System Administration + get: + description: List a specific tenant operator. + operationId: get-v2.0-api-tenants-tenant_id-operators-operator_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The operator ID. + in: path + name: operator_id + required: true + schema: + description: Operator Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OperatorV2N1' + description: Get an Operator + summary: Get Tenant Operator (v2.0) + tags: + - System Administration + patch: + description: Patch a tenant operator + operationId: patch-v2.0-api-tenants-tenant_id-operators-operator_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Operator Id + in: path + name: operator_id + required: true + schema: + description: Operator Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OperatorV2N1' + description: Operator details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OperatorV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + - code: OPERATOR_INVALID_OPERATOR_EMAIL + - code: OPERATOR_INVALID_ETAG + - code: OPERATOR_INVALID_SIGNUP_ROLE + - code: OPERATOR_INVALID_SUBJECT_TENANT_ID + - code: OPERATOR_INVALID_OPERATOR_ID + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Patch a tenant operator (v2.0) + tags: + - System Administration + put: + description: Update a specific tenant operator. + operationId: put-v2.0-api-tenants-tenant_id-operators-operator_id + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The operator ID. + in: path + name: operator_id + required: true + schema: + description: Operator Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OperatorV2N1' + description: Operator details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OperatorV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + - code: OPERATOR_INVALID_SIGNUP_ROLE + - code: OPERATOR_INVALID_SUBJECT_TENANT_ID + - code: OPERATOR_INVALID_OPERATOR_ID + - code: OPERATOR_INVALID_OPERATOR_EMAIL + - code: OPERATOR_INVALID_ETAG + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Tenant Operator (v2.0) + tags: + - System Administration + /v2.0/api/tenants/{tenant_id}/operators/{operator_id}/authtokens: + get: + description: List all the auth tokens. + operationId: get-v2.0-api-tenants-tenant_id-operators-operator_id-authtokens + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The operator ID. + in: path + name: operator_id + required: true + schema: + description: Operator Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AuthToken' + type: array + type: object + description: Successful Operation + summary: Get Auth Tokens (v2.0) + tags: + - System Administration + post: + description: Create an auth token. + operationId: post-v2.0-api-tenants-tenant_id-operators-operator_id-authtokens + parameters: + - description: The tenant ID. + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: The operator ID. + in: path + name: operator_id + required: true + schema: + description: Operator Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthToken' + description: Auth token details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthToken' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TOKEN_INVALID_SESSION_DATA - code: ESP_INVALID_TENANT_DATA - code: TOKEN_INVALID_OPERATOR_ID - code: TOKEN_INVALID_SUBJECT_ID @@ -4780,10 +5189,10 @@ paths: summary: Create SSO Session (v2.0) tags: - System Administration - /v2.0/api/tenants/{tenant_id}/saml_idp: + /v2.0/api/tenants/{tenant_id}/signup: post: - description: Process SAML request from SP. - operationId: post-v2.0-api-tenants-tenant_id-saml_idp + description: Sign up new operators. + operationId: post-v2.0-api-tenants-tenant_id-signup parameters: - description: The tenant ID. in: path @@ -4796,14 +5205,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SamlRequest' - description: SAMLRequest + $ref: '#/components/schemas/Signup' + description: Signup details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/AuthResource' + $ref: '#/components/schemas/Signup' description: Successful Operation '400': content: @@ -4811,54 +5220,16 @@ paths: example: value: _error: - - code: BAD_REQUEST + - code: OPERATOR_INVALID_TENANT_DATA + - code: OPERATOR_INVALID_SIGNUP_REQUEST + - code: OPERATOR_INVALID_SIGNUP_ROLE + - code: OPERATOR_INVALID_SUBJECT_TENANT_ID + - code: OPERATOR_INVALID_OPERATOR_EMAIL + - code: OPERATOR_SIGNUP_EXISTS 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. - operationId: post-v2.0-api-tenants-tenant_id-signup - 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/Signup' - description: Signup details - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Signup' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: OPERATOR_INVALID_TENANT_DATA - - code: OPERATOR_INVALID_SIGNUP_REQUEST - - code: OPERATOR_INVALID_SIGNUP_ROLE - - code: OPERATOR_INVALID_SUBJECT_TENANT_ID - - code: OPERATOR_INVALID_OPERATOR_EMAIL - - code: OPERATOR_SIGNUP_EXISTS - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Sign New Operators (v2.0) + summary: Sign New Operators (v2.0) tags: - System Administration /v2.0/api/tenants/{tenant_id}/users: @@ -5072,6 +5443,120 @@ paths: summary: Get User Profile (v2.1) tags: - System Administration + /v2.1/api/tenants/{tenant_id}: + get: + description: Get tenant details for tenant id + operationId: get-v2.1-api-tenants-tenant_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TenantV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get tenant details for tenant id (v2.1) + tags: + - System Administration + patch: + description: Patch tenant + operationId: patch-v2.1-api-tenants-tenant_id + 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/TenantV2N1' + description: Tenant details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TenantV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: OPERATOR_INVALID_ETAG + - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Patch tenant (v2.1) + tags: + - System Administration + put: + description: Update tenant + operationId: put-v2.1-api-tenants-tenant_id + 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/TenantV2N1' + description: Tenant details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TenantV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: OPERATOR_INVALID_ETAG + - code: TENANT_INVALID_CANONICAL_NAME_CHANGE + - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update tenant (v2.1) + tags: + - System Administration /v2.1/api/tenants/{tenant_id}/clients/{client_id}/roles: get: description: List all the client custom roles. @@ -5685,17 +6170,17 @@ paths: - System Administration /v2.1/api/tenants/{tenant_id}/operators/{operator_id}: delete: - description: Delete a specific tenant operator. + description: Delete a tenant operator operationId: delete-v2.1-api-tenants-tenant_id-operators-operator_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The operator ID. + - description: Operator Id in: path name: operator_id required: true @@ -5720,14 +6205,42 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Tenant Operator (v2.1) + summary: Delete a tenant operator (v2.1) tags: - System Administration get: - description: List a specific tenant operator. + description: Get a tenant operator operationId: get-v2.1-api-tenants-tenant_id-operators-operator_id parameters: - - description: The tenant ID. + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Operator Id + in: path + name: operator_id + required: true + schema: + description: Operator Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OperatorV2N1' + description: Successful Operation + summary: Get a tenant operator (v2.1) + tags: + - System Administration + patch: + description: Patch a tenant operator. + operationId: patch-v2.1-api-tenants-tenant_id-operators-operator_id + parameters: + - description: ID of the tenant. in: path name: tenant_id required: true @@ -5741,6 +6254,12 @@ paths: schema: description: Operator Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OperatorV2N1' + description: Operator details responses: '200': content: @@ -5748,21 +6267,40 @@ paths: schema: $ref: '#/components/schemas/OperatorV2N1' description: Successful Operation - summary: Get Tenant Operator (v2.1) + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + - code: OPERATOR_INVALID_OPERATOR_EMAIL + - code: OPERATOR_INVALID_ETAG + - code: OPERATOR_INVALID_SIGNUP_ROLE + - code: OPERATOR_INVALID_SUBJECT_TENANT_ID + - code: OPERATOR_INVALID_OPERATOR_ID + - code: OPERATOR_INVALID_OPERATOR_MULTIPLE_SYSTEM_ROLE + - code: OPERATOR_INVALID_OPERATOR_SYSTEM_ROLE + - code: OPERATOR_CAN_NOT_ASSIGN_SYSTEM_GENERATED_CUSTOM_ROLE + - code: OPERATOR_INVALID_CANNOT_SET_READONLY_FIELDS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Patch Tenant Operator (v2.1) tags: - System Administration put: - description: Update a specific tenant operator. + description: Update a tenant operator operationId: put-v2.1-api-tenants-tenant_id-operators-operator_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The operator ID. + - description: Operator Id in: path name: operator_id required: true @@ -5801,7 +6339,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Operator (v2.1) + summary: Update a tenant operator (v2.1) tags: - System Administration /v2.1/api/tenants/{tenant_id}/operators/{operator_id}/authtokens: @@ -6321,12 +6859,12 @@ paths: summary: Update Custom Role (v2.1) tags: - System Administration - /v2.2/api/tenants/{tenant_id}/operators: + /v2.2/api/tenants/{tenant_id}: get: - description: Get a list of tenant operators. - operationId: get-v2.2-api-tenants-tenant_id-operators + description: Get tenant details for tenant id + operationId: get-v2.2-api-tenants-tenant_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true @@ -6338,23 +6876,27 @@ paths: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/OperatorV2N2' - type: array - type: object + $ref: '#/components/schemas/TenantV2N2' description: Successful Operation - summary: Get Tenant Operators (v2.2) + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get tenant details for tenant id (v2.2) tags: - System Administration - post: - description: Create a tenant operator. - operationId: post-v2.2-api-tenants-tenant_id-operators + patch: + description: Patch tenant + operationId: patch-v2.2-api-tenants-tenant_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true @@ -6365,14 +6907,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OperatorV2N2' - description: Operator details + $ref: '#/components/schemas/TenantV2N2' + description: Tenant details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/OperatorV2N2' + $ref: '#/components/schemas/TenantV2N2' description: Successful Operation '400': content: @@ -6380,46 +6922,39 @@ paths: example: value: _error: - - code: BAD_REQUEST - - code: OPERATOR_INVALID_OPERATOR_EMAIL - - code: SESSION_SUBJECT_NOT_FOUND - - code: OPERATOR_INVALID_SIGNUP_ROLE - - code: OPERATOR_INVALID_SUBJECT_TENANT_ID - - code: OPERATOR_INVALID_OPERATOR_MULTIPLE_SYSTEM_ROLE - - code: OPERATOR_INVALID_OPERATOR_SYSTEM_ROLE - - code: OPERATOR_CAN_NOT_ASSIGN_SYSTEM_GENERATED_CUSTOM_ROLE - - code: OPERATOR_INVALID_CANNOT_SET_READONLY_FIELDS + - code: OPERATOR_INVALID_ETAG + - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Tenant Operator (v2.2) + summary: Patch tenant (v2.2) tags: - System Administration - /v2.2/api/tenants/{tenant_id}/operators/{operator_id}: - delete: - description: Delete a specific tenant operator. - operationId: delete-v2.2-api-tenants-tenant_id-operators-operator_id + put: + description: Update tenant + operationId: put-v2.2-api-tenants-tenant_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The operator ID. - in: path - name: operator_id - required: true - schema: - description: Operator Id - type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TenantV2N2' + description: Tenant details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/OperatorV2N2' + $ref: '#/components/schemas/TenantV2N2' description: Successful Operation '400': content: @@ -6427,72 +6962,113 @@ paths: example: value: _error: - - code: OPERATOR_INVALID_SIGNUP_ROLE - - code: OPERATOR_DELETE_INVALID_ROLE_SYSTEM + - code: OPERATOR_INVALID_ETAG + - code: TENANT_INVALID_CANONICAL_NAME_CHANGE + - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Tenant Operator (v2.2) + summary: Update tenant (v2.2) tags: - System Administration + /v2.3/api/tenants/{tenant_id}: get: - description: List a specific tenant operator. - operationId: get-v2.2-api-tenants-tenant_id-operators-operator_id + description: Get tenant details for tenant id + operationId: get-v2.3-api-tenants-tenant_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The operator ID. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TenantV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get tenant details for tenant id (v2.3) + tags: + - System Administration + patch: + description: Patch tenant + operationId: patch-v2.3-api-tenants-tenant_id + parameters: + - description: Tenant Id in: path - name: operator_id + name: tenant_id required: true schema: - description: Operator Id + description: Tenant Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TenantV2N3' + description: Tenant details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/OperatorV2N2' + $ref: '#/components/schemas/TenantV2N3' description: Successful Operation - summary: Get Tenant Operator (v2.2) + '400': + content: + application/json: + example: + value: + _error: + - code: OPERATOR_INVALID_ETAG + - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Patch tenant (v2.3) tags: - System Administration put: - description: Update a specific tenant operator. - operationId: put-v2.2-api-tenants-tenant_id-operators-operator_id + description: Update tenant + operationId: put-v2.3-api-tenants-tenant_id parameters: - - description: The tenant ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The operator ID. - in: path - name: operator_id - required: true - schema: - description: Operator Id - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/OperatorV2N2' - description: Operator details + $ref: '#/components/schemas/TenantV2N3' + description: Tenant details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/OperatorV2N2' + $ref: '#/components/schemas/TenantV2N3' description: Successful Operation '400': content: @@ -6500,28 +7076,23 @@ paths: example: value: _error: - - code: BAD_REQUEST - - code: OPERATOR_INVALID_SIGNUP_ROLE - - code: OPERATOR_INVALID_SUBJECT_TENANT_ID - - code: OPERATOR_INVALID_OPERATOR_ID - - code: OPERATOR_INVALID_OPERATOR_EMAIL - code: OPERATOR_INVALID_ETAG - - code: OPERATOR_INVALID_OPERATOR_MULTIPLE_SYSTEM_ROLE - - code: OPERATOR_INVALID_OPERATOR_SYSTEM_ROLE - - code: OPERATOR_CAN_NOT_ASSIGN_SYSTEM_GENERATED_CUSTOM_ROLE - - code: OPERATOR_INVALID_CANNOT_SET_READONLY_FIELDS + - code: TENANT_INVALID_CANONICAL_NAME_CHANGE + - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Operator (v2.2) + summary: Update tenant (v2.3) tags: - System Administration - /v2.6/api/tenants/{tenant_id}: + /v3.0/api/tenants/{tenant_id}/idps: get: - description: Get the tenant details for a tenant ID. - operationId: get-v2.6-api-tenants-tenant_id + description: Get all idps + operationId: get-v3.0-api-tenants-tenant_id-idps parameters: - - description: The tenant or TSG ID. + - description: Tenant Id in: path name: tenant_id required: true @@ -6533,7 +7104,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TenantV2N5' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/Idp' + type: array + type: object + description: Successful Operation + summary: Get all idps (v3.0) + tags: + - System Administration + post: + description: Create idp + operationId: post-v3.0-api-tenants-tenant_id-idps + 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/Idp' + description: Idp details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Idp' description: Successful Operation '400': content: @@ -6541,37 +7146,100 @@ paths: example: value: _error: - - code: TENANT_INVALID_CLIENT_ID - - code: ESP_INVALID_CLIENT_DATA + - code: BAD_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Tenant Details for Tenant ID (v2.6) + summary: Create idp (v3.0) + tags: + - System Administration + /v3.0/api/tenants/{tenant_id}/idps/{idp_id}: + delete: + description: Delete idp + operationId: delete-v3.0-api-tenants-tenant_id-idps-idp_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Idp Id + in: path + name: idp_id + required: true + schema: + description: Idp Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Idp' + description: Successful Operation + summary: Delete idp (v3.0) + tags: + - System Administration + get: + description: Get idp + operationId: get-v3.0-api-tenants-tenant_id-idps-idp_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Idp Id + in: path + name: idp_id + required: true + schema: + description: Idp Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Idp' + description: Successful Operation + summary: Get idp (v3.0) tags: - System Administration put: - description: Update the tenant details for a tenant ID. - operationId: put-v2.6-api-tenants-tenant_id + description: Update sso + operationId: put-v3.0-api-tenants-tenant_id-idps-idp_id parameters: - - description: The tenant or TSG ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string + - description: Sso Id + in: path + name: idp_id + required: true + schema: + description: Idp Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TenantV2N5' - description: Tenant details + $ref: '#/components/schemas/Idp' + description: Sso details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/TenantV2N5' + $ref: '#/components/schemas/Idp' description: Successful Operation '400': content: @@ -6579,23 +7247,19 @@ paths: example: value: _error: - - code: OPERATOR_INVALID_ETAG - - code: TENANT_INVALID_CANONICAL_NAME_CHANGE - - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT - - code: TENANT_INVALID_CLIENT_ID - - code: ESP_INVALID_CLIENT_DATA + - code: SSO_INVALID_ETAG schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Details for Tenant ID (v2.6) + summary: Update sso (v3.0) tags: - System Administration - /v2.7/api/tenants/{tenant_id}: + /v3.1/api/tenants/{tenant_id}/idps: get: - description: Get the tenant details for a tenant ID. - operationId: get-v2.7-api-tenants-tenant_id + description: Get all idps + operationId: get-v3.1-api-tenants-tenant_id-idps parameters: - - description: The tenant or TSG ID. + - description: Tenant Id in: path name: tenant_id required: true @@ -6607,7 +7271,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TenantV2N7' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/IdpV3N1' + type: array + type: object + description: Successful Operation + summary: Get all idps (v3.1) + tags: + - System Administration + post: + description: Create idp + operationId: post-v3.1-api-tenants-tenant_id-idps + 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/IdpV3N1' + description: Idp details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IdpV3N1' description: Successful Operation '400': content: @@ -6615,37 +7313,100 @@ paths: example: value: _error: - - code: TENANT_INVALID_CLIENT_ID - - code: ESP_INVALID_CLIENT_DATA + - code: BAD_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Tenant Details for Tenant ID (v2.7) + summary: Create idp (v3.1) + tags: + - System Administration + /v3.1/api/tenants/{tenant_id}/idps/{idp_id}: + delete: + description: Delete idp + operationId: delete-v3.1-api-tenants-tenant_id-idps-idp_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Idp Id + in: path + name: idp_id + required: true + schema: + description: Idp Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IdpV3N1' + description: Successful Operation + summary: Delete idp (v3.1) + tags: + - System Administration + get: + description: Get idp + operationId: get-v3.1-api-tenants-tenant_id-idps-idp_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Idp Id + in: path + name: idp_id + required: true + schema: + description: Idp Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IdpV3N1' + description: Successful Operation + summary: Get idp (v3.1) tags: - System Administration put: - description: Update the tenant details for a tenant ID. - operationId: put-v2.7-api-tenants-tenant_id + description: Update sso + operationId: put-v3.1-api-tenants-tenant_id-idps-idp_id parameters: - - description: The tenant or TSG ID. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string + - description: Sso Id + in: path + name: idp_id + required: true + schema: + description: Idp Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TenantV2N7' - description: Tenant details + $ref: '#/components/schemas/IdpV3N1' + description: Sso details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/TenantV2N7' + $ref: '#/components/schemas/IdpV3N1' description: Successful Operation '400': content: @@ -6653,15 +7414,11 @@ paths: example: value: _error: - - code: OPERATOR_INVALID_ETAG - - code: TENANT_INVALID_CANONICAL_NAME_CHANGE - - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT - - code: TENANT_INVALID_CLIENT_ID - - code: ESP_INVALID_CLIENT_DATA + - code: SSO_INVALID_ETAG schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Details for Tenant ID (v2.7) + summary: Update sso (v3.1) 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 44e3172b7..762cc0af0 100644 --- a/openapi-specs/sdwan/legacy/Topology.yaml +++ b/openapi-specs/sdwan/legacy/Topology.yaml @@ -34,21 +34,9 @@ components: 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: @@ -58,28 +46,167 @@ components: - avg - sum type: string - statistic: - description: 'QoS application aggregate statistics. - - ' + AnynetLinkV2: + properties: + ep1_site_id: + description: Ep1 Site Id type: string - unit: - description: 'The unit. - - ' + 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 + id: + description: Id + type: string + tenant_id: + description: Tenant Id + type: string + type: + description: Type + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE type: string - AggregateData: + AnynetLinkV3: properties: - value: - description: 'Value of the aggregate data. - - ' - type: number - view: - description: 'View the aggregate date. - - ' - type: object + admin_up: + description: Admin Up + type: boolean + 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: Id + type: string + tenant_id: + description: Tenant Id + type: string + type: + description: Type + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + AnynetLinkV3N1: + properties: + admin_up: + description: Admin Up + type: boolean + description: + description: Description + type: string + 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: Id + type: string + name: + description: Name + type: string + tags: + description: Tags + items: + description: Tags + type: string + type: array + tenant_id: + description: Tenant Id + type: string + type: + description: Type + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + AnynetLinkV3N2: + properties: + admin_up: + description: Admin Up + type: boolean + description: + description: Description + type: string + 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: Id + type: string + name: + description: Name + type: string + tags: + description: Tags + items: + description: Tags + type: string + type: array + tenant_id: + description: Tenant Id + type: string + type: + description: Type + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'Vpnlink Configuration: Valid ' AnynetLinkV3N3: properties: admin_up: @@ -543,189 +670,320 @@ components: type: string required: - tenant_id - NetworkLinkV3N3: + NetworkLinkV3: properties: admin_up: - description: 'The interface admin state. - - ' + description: Admin Up type: boolean anynet_link_id: - description: 'The anynet link ID.. - - ' + description: 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. - - ' + description: Elem Interface Id type: string element_id: - description: 'The element ID. - - ' + description: Element Id type: string id: - description: 'The ID. - - ' + description: 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. - - ' + description: Source Circuit Name type: string source_node_id: - description: 'The source node ID. - - ' + description: Source Node Id type: string source_site_name: - description: 'The source site name. - - ' + description: Source Site Name type: string source_wan_if_id: - description: 'The source WAN ID. - - ' + description: Source Wan If Id type: string source_wan_network: - description: 'The source WAN network. - - ' + description: Source Wan Network type: string source_wan_nw_id: - description: 'The The source WAN network ID. - - ' + description: Source Wan Nw Id type: string status: - description: 'The status of the link. - - ' + description: Status 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. - - ' + description: Target Circuit Name type: string target_node_id: - description: 'The target node ID. - - ' + description: Target Node Id type: string target_site_name: - description: 'The target site name. - - ' + description: Target Site Name type: string target_wan_if_id: - description: 'The target WAN ID. - - ' + description: Target Wan If Id type: string target_wan_network: - description: 'The target WAN network. - - ' + description: Target Wan Network type: string target_wan_nw_id: - description: 'The The target WAN network ID. - - ' + description: Target Wan Nw Id type: string tenant_id: - description: 'The active user tenant ID. - - ' + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' type: string type: - description: 'Anynet link type. - - ' + description: Type type: string - vpnlink_configuration: - $ref: '#/components/schemas/VPNLinkConfiguration' - description: 'The configuration of the VPN link. - - ' vpnlinks: - description: 'The VPN links info. - - ' + description: Vpnlinks items: description: Vpnlinks type: string type: array wan_if_id: - description: 'The WAN ID. - - ' + description: Wan If Id type: string wan_nw_id: - description: 'The WAN network ID. - - ' + description: Wan Nw Id type: string wan_nw_name: - description: 'The WAN network name. - - ' + description: Wan Nw Name type: string required: - tenant_id - NetworkLinkV3N4: + NetworkLinkV3N1: + properties: + admin_up: + description: Admin Up + type: boolean + anynet_link_id: + description: Anynet Link Id + type: string + description: + description: Description + type: string + elem_interface_id: + description: Elem Interface Id + type: string + element_id: + description: Element Id + type: string + id: + description: Id + type: string + in_use: + description: In Use + type: boolean + name: + description: Name + type: string + network: + description: Network + type: string + path_id: + description: Path Id + type: string + sep_name: + description: Sep Name + type: string + source_circuit_name: + description: Source Circuit Name + type: string + source_node_id: + description: Source Node Id + type: string + source_site_name: + description: Source Site Name + type: string + source_wan_if_id: + description: Source Wan If Id + type: string + source_wan_network: + description: Source Wan Network + type: string + source_wan_nw_id: + description: Source Wan Nw Id + type: string + status: + description: Status + type: string + sub_type: + description: Sub Type + type: string + tags: + description: Tags + items: + description: Tags + type: string + type: array + target_circuit_name: + description: Target Circuit Name + type: string + target_node_id: + description: Target Node Id + type: string + target_site_name: + description: Target Site Name + type: string + target_wan_if_id: + description: Target Wan If Id + type: string + target_wan_network: + description: Target Wan Network + type: string + target_wan_nw_id: + description: Target Wan Nw Id + type: string + tenant_id: + description: 'Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) ' + type: string + type: + description: Type + type: string + vpnlinks: + description: Vpnlinks + items: + description: Vpnlinks + type: string + type: array + wan_if_id: + description: Wan If Id + type: string + wan_nw_id: + description: Wan Nw Id + type: string + wan_nw_name: + description: Wan Nw Name + type: string + required: + - tenant_id + NetworkLinkV3N2: + properties: + admin_up: + description: Admin Up + type: boolean + anynet_link_id: + description: Anynet Link Id + type: string + description: + description: Description + type: string + elem_interface_id: + description: Elem Interface Id + type: string + element_id: + description: Element Id + type: string + id: + description: Id + type: string + in_use: + description: In Use + type: boolean + name: + description: Name + type: string + network: + description: Network + type: string + path_id: + description: Path Id + type: string + sep_name: + description: Sep Name + type: string + source_circuit_name: + description: Source Circuit Name + type: string + source_elem_if_id: + description: Source Elem If Id + type: string + source_node_id: + description: Source Node Id + type: string + source_site_name: + description: Source Site Name + type: string + source_wan_if_id: + description: Source Wan If Id + type: string + source_wan_network: + description: Source Wan Network + type: string + source_wan_nw_id: + description: Source Wan Nw Id + type: string + status: + description: Status + type: string + sub_type: + description: Sub Type + type: string + tags: + description: Tags + items: + description: Tags + type: string + type: array + target_circuit_name: + description: Target Circuit Name + type: string + target_elem_if_id: + description: Target Elem If Id + type: string + target_node_id: + description: Target Node Id + type: string + target_site_name: + description: Target Site Name + type: string + target_wan_if_id: + description: Target Wan If Id + type: string + target_wan_network: + description: Target Wan Network + type: string + target_wan_nw_id: + description: Target Wan Nw Id + type: string + tenant_id: + description: Tenant Id + type: string + type: + description: Type + type: string + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: Vpnlink Configuration + vpnlinks: + description: Vpnlinks + items: + description: Vpnlinks + type: string + type: array + wan_if_id: + description: Wan If Id + type: string + wan_nw_id: + description: Wan Nw Id + type: string + wan_nw_name: + description: Wan Nw Name + type: string + NetworkLinkV3N3: properties: admin_up: description: 'The interface admin state. @@ -847,12 +1105,6 @@ components: ' 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. @@ -911,58 +1163,306 @@ components: ' type: string - NetworkNode: + required: + - tenant_id + NetworkLinkV3N4: properties: - address: - $ref: '#/components/schemas/Address' - description: 'The network address details. + admin_up: + description: 'The interface admin state. ' - elem_hw_id: - description: 'The element hardware ID. + type: boolean + anynet_link_id: + description: 'The anynet link ID.. ' type: string - id: - description: 'The ID. + 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 - location: - $ref: '#/components/schemas/Location' - description: 'The network node location. + element_id: + description: 'The element ID. + + ' + type: string + id: + description: 'The ID. ' + type: string + in_use: + description: In Use + type: boolean name: - description: 'The network name. Max size = 128. + description: 'The anynet link name. Max size = 128. ' type: string - role: - description: Role + network: + description: Network type: string - site_id: - description: "The site ID. \n" + path_id: + description: Path Id type: string - spoke_cluster_elem_status: - description: 'The spoke cluster element status. - - ' + sep_id: + description: Sep Id type: string - state: - description: State + sep_name: + description: Sep Name type: string - tenant_id: - description: 'The active user tenant ID. + source_circuit_name: + description: 'The name of the source circuit. ' type: string - type: - description: 'Anynet link type. + source_elem_if_id: + description: 'The source element ID. ' type: string - NetworkTopologyV3N3: + 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. + + ' + 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 + NetworkTopologyV3: + properties: + links: + description: Links + items: + $ref: '#/components/schemas/NetworkLinkV3' + type: array + nodes: + description: Nodes + items: + $ref: '#/components/schemas/NetworkNode' + type: array + type: + description: Type + enum: + - ANYNET + - ANYNETPLUS + - BASENET + - PHYSICAL + type: string + NetworkTopologyV3N1: + properties: + links: + description: Links + items: + $ref: '#/components/schemas/NetworkLinkV3N1' + type: array + nodes: + description: Nodes + items: + $ref: '#/components/schemas/NetworkNode' + type: array + type: + description: Type + enum: + - ANYNET + - ANYNETPLUS + - BASENET + - PHYSICAL + type: string + NetworkTopologyV3N2: + properties: + links: + description: Links + items: + $ref: '#/components/schemas/NetworkLinkV3N2' + type: array + nodes: + description: Nodes + items: + $ref: '#/components/schemas/NetworkNode' + type: array + type: + description: Type + enum: + - ANYNET + - ANYNETPLUS + - BASENET + - PHYSICAL + type: string + NetworkTopologyV3N3: properties: links: description: 'Query the anynet links. @@ -1026,6 +1526,40 @@ components: start: $ref: '#/components/schemas/Location' description: Start + TopologyQuery: + properties: + links: + description: Links + items: + description: Links + type: string + type: array + links_only: + description: Links Only + type: boolean + location: + $ref: '#/components/schemas/SiteLocation' + description: Location + nodes: + description: Nodes + items: + description: Nodes + type: string + type: array + site_id: + description: Site Id + type: string + sites: + $ref: '#/components/schemas/SiteEndpoints' + description: Sites + type: + description: Type + enum: + - ANYNET + - ANYNETPLUS + - BASENET + - PHYSICAL + type: string TopologyQueryV3N1: properties: links: @@ -1321,19 +1855,144 @@ info: 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 + /v2.0/api/tenants/{tenant_id}/anynetlinks: + post: + description: Create anynet link + operationId: post-v2.0-api-tenants-tenant_id-anynetlinks parameters: - - description: The ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: ID of the site. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV2' + 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 (v2.0) + tags: + - Topology + /v2.0/api/tenants/{tenant_id}/anynetlinks/{anynet_id}: + delete: + description: Delete anynet link + operationId: delete-v2.0-api-tenants-tenant_id-anynetlinks-anynet_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: 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 (v2.0) + tags: + - Topology + put: + description: update anynet link + operationId: put-v2.0-api-tenants-tenant_id-anynetlinks-anynet_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Anynet Id + in: path + name: anynet_id + required: true + schema: + description: Anynet Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV2' + 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 (v2.0) + tags: + - Topology + /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 @@ -1441,40 +2100,679 @@ paths: example: value: _error: - - code: VPL_NOT_FOUND - - code: VPL_ACTION_INSUFFICIENT_VPE - - code: VPNLINK_INVALID_ACTION + - 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 + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WanOverlay' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - 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: Get App/WAN Context (v2.0) + tags: + - Topology + 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 + 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/WanOverlay' + description: Details of the appwan context to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WanOverlay' + description: Successful Operation + '400': + content: + application/json: + 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_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update App/WAN Context (v2.0) + 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 + 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/VPLStatusV2N1' + 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.1) + tags: + - Topology + /v3.0/api/tenants/{tenant_id}/anynetlinks: + post: + description: Create anynet link + operationId: post-v3.0-api-tenants-tenant_id-anynetlinks + 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/AnynetLinkV3' + 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.0) + tags: + - Topology + /v3.0/api/tenants/{tenant_id}/anynetlinks/{anynet_id}: + delete: + description: Delete anynet link + operationId: delete-v3.0-api-tenants-tenant_id-anynetlinks-anynet_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: 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.0) + tags: + - Topology + get: + description: GET anynet link + operationId: get-v3.0-api-tenants-tenant_id-anynetlinks-anynet_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Anynet Id + in: path + name: anynet_id + required: true + schema: + description: Anynet Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkLinkV3' + description: Successful Operation + '404': + description: not found + summary: GET anynet link (v3.0) + tags: + - Topology + put: + description: Update anynet link + operationId: put-v3.0-api-tenants-tenant_id-anynetlinks-anynet_id + parameters: + - description: Tenant Id + in: path + name: tenant_id + required: true + schema: + description: Tenant Id + type: string + - description: Anynet Id + in: path + name: anynet_id + required: true + schema: + description: Anynet Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV3' + 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.0) + tags: + - Topology + /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: 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 + 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.0/api/tenants/{tenant_id}/topology: + post: + description: Query topology + operationId: post-v3.0-api-tenants-tenant_id-topology + 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/TopologyQuery' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkTopologyV3' + 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.0) + tags: + - Topology + /v3.1/api/tenants/{tenant_id}/anynetlinks: + post: + description: Create anynet link + operationId: post-v3.1-api-tenants-tenant_id-anynetlinks + 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/AnynetLinkV3N1' + 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: Perform Operation on VPN Link (v2.0) + summary: Create anynet link (v3.1) 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 + /v3.1/api/tenants/{tenant_id}/anynetlinks/{anynet_id}: + delete: + description: Delete anynet link + operationId: delete-v3.1-api-tenants-tenant_id-anynetlinks-anynet_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the VPN link. + - description: 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/VPLAdminState' + $ref: '#/components/schemas/Anynetlink' description: Successful Operation '400': content: @@ -1482,85 +2780,74 @@ 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 Admin State (v2.0) + summary: Delete anynet link (v3.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 + get: + description: GET anynet link + operationId: get-v3.1-api-tenants-tenant_id-anynetlinks-anynet_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the VPN link. + - description: Anynet Id in: path - name: vpn_link_id + name: anynet_id required: true schema: - description: Vpn Link Id + description: Anynet Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VPLAdminState' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VPLAdminState' + $ref: '#/components/schemas/NetworkLinkV3N1' 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) + '404': + description: not found + summary: GET anynet link (v3.1) 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 + put: + description: Update anynet link + operationId: put-v3.1-api-tenants-tenant_id-anynetlinks-anynet_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the VPN link. + - description: Anynet Id in: path - name: vpn_link_id + name: anynet_id required: true schema: - description: Vpn Link Id + description: Anynet Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV3N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VPLStatus' + $ref: '#/components/schemas/Anynetlink' description: Successful Operation '400': content: @@ -1568,48 +2855,62 @@ paths: example: value: _error: - - code: VPL_NOT_FOUND - - code: VPL_ACTION_INSUFFICIENT_VPE + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: TOPOLOGY_REBUILD_IN_PROGRESS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get VPN Link Status (v2.0) + summary: Update anynet link (v3.1) 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 + /v3.1/api/tenants/{tenant_id}/topology: + post: + description: Query topology + operationId: post-v3.1-api-tenants-tenant_id-topology parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TopologyQueryV3N1' 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/NetworkTopologyV3N1' description: Successful Operation - summary: Get App/WAN Contexts (v2.0) + '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.1) tags: - Topology + /v3.2/api/tenants/{tenant_id}/anynetlinks: post: - description: Create a new app/wan context. - operationId: post-v2.0-api-tenants-tenant_id-wanoverlays + description: Create anynet link + operationId: post-v3.2-api-tenants-tenant_id-anynetlinks parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true @@ -1620,14 +2921,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/WanOverlay' - description: Details of the appwan context to be created + $ref: '#/components/schemas/AnynetLinkV3N2' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WanOverlay' + $ref: '#/components/schemas/Anynetlink' description: Successful Operation '400': content: @@ -1635,44 +2935,40 @@ 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: Create anynet link (v3.2) tags: - Topology - /v2.0/api/tenants/{tenant_id}/wanoverlays/{wan_overlay_id}: + /v3.2/api/tenants/{tenant_id}/anynetlinks/{anynet_id}: delete: - description: Create a new app/wan context. - operationId: delete-v2.0-api-tenants-tenant_id-wanoverlays-wan_overlay_id + description: Delete anynet link + operationId: delete-v3.2-api-tenants-tenant_id-anynetlinks-anynet_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the WAN overlay. + - description: 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: @@ -1680,83 +2976,74 @@ paths: example: value: _error: - - code: WANOVERLAY_IN_USE + - code: TOPOLOGY_REBUILD_IN_PROGRESS + - code: NO_ANYNETLINK_FOUND + - code: INVALID_ANYNETLINK_TYPE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete App/WAN Context (v2.0) + summary: Delete anynet link (v3.2) tags: - Topology get: - description: List the new app/wan context. - operationId: get-v2.0-api-tenants-tenant_id-wanoverlays-wan_overlay_id + description: GET anynet link + operationId: get-v3.2-api-tenants-tenant_id-anynetlinks-anynet_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the WAN overlay. + - description: 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/NetworkLinkV3N2' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - 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: Get App/WAN Context (v2.0) + '404': + description: not found + summary: GET anynet link (v3.2) tags: - Topology put: - description: Update a new app/wan context. - operationId: put-v2.0-api-tenants-tenant_id-wanoverlays-wan_overlay_id + description: Update anynet link + operationId: put-v3.2-api-tenants-tenant_id-anynetlinks-anynet_id parameters: - - description: ID of the tenant. + - description: Tenant Id in: path name: tenant_id required: true schema: description: Tenant Id type: string - - description: The ID of the WAN overlay. + - description: 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/AnynetLinkV3N2' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WanOverlay' + $ref: '#/components/schemas/Anynetlink' description: Successful Operation '400': content: @@ -1764,45 +3051,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.2) 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.2/api/tenants/{tenant_id}/topology: + post: + description: Query topology + operationId: post-v3.2-api-tenants-tenant_id-topology parameters: - - description: ID of the tenant. + - description: 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/NetworkTopologyV3N2' description: Successful Operation '400': content: @@ -1810,48 +3090,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) - tags: - - Topology - /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: 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 - 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) + summary: Query topology (v3.2) tags: - Topology /v3.3/api/tenants/{tenant_id}/anynetlinks: diff --git a/openapi-specs/sdwan/unified/Applications.yaml b/openapi-specs/sdwan/unified/Applications.yaml index f186b8a2d..596807988 100644 --- a/openapi-specs/sdwan/unified/Applications.yaml +++ b/openapi-specs/sdwan/unified/Applications.yaml @@ -2,21 +2,9 @@ components: schemas: Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -30,28 +18,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 AppDefQuery: properties: aggregate: @@ -119,7 +85,7 @@ components: ' format: int64 type: integer - AppDefQueryFilterTransformedV2N3: + AppDefQueryFilterTransformed: properties: abbreviation: description: 'Abbreviation of the application name. @@ -127,9 +93,7 @@ components: ' type: string aggregate_flows: - description: 'The aggregate flows. - - ' + description: Aggregate Flows type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined @@ -137,11 +101,6 @@ components: ' type: string - app_unreachability_detection: - description: 'Application unreachability detection. - - ' - type: boolean category: description: 'The application category. @@ -230,33 +189,23 @@ components: ' type: string ingress_traffic_pct: - description: "The app def ingress traffic. Application ingress traffic percentage\ - \ should be in between 1-99. \n" + 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) ' format: int32 type: integer ip_rules: - description: 'Applicable for L3/L4 applications. These are IP Prefix rules - used to identify the application viz protocol, dscp, source & destination - prefixes and source & destination prefixes. - - ' + description: 'Ip Rules: Valid Size(max = 16, error = APPDEF_CONFIG_MAX_SIZE_EXCEED: + Allowed max size is 16 for each of them - tcp_rules, ip_rules and udp_rules., + min = 0) ' items: type: object type: array - is_deprecated: - description: 'Deprecated application definitions. - - ' - type: boolean - network_scan_application: - description: 'If true, it enables Network Scan App to designate custom applications - as network scan applications. - - ' - type: boolean order_number: - description: "The app config order number. Order number should be between\ - \ 1-65535. \n" + 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: @@ -265,17 +214,14 @@ components: ' type: boolean - parent_id: - description: 'Parent app ID. + path_affinity: + description: 'This parameter defines the path affinity characteristics to + consider during flow decision making. Allowed values: "none" "weak" "strict". + If path affinity is none or weak and a better path is available, flows + will be moved to a new path. If path affinity is strict, all application + flows will continue on the same path. ' - type: string - path_affinity: - description: "This parameter defines the path affinity characteristics to\ - \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ - \ \"strict\". If path affinity is none or weak and a better path is available,\ - \ flows will be moved to a new path. If path affinity is strict, all application\ - \ flows will continue on the same path. \n" enum: - none - weak @@ -294,25 +240,27 @@ components: ' type: boolean tags: - description: 'A information field that can be added to identify the application. - Maximum 10 Unique tags of length 1024 each are allowed. - - ' + 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) ' items: description: Tags type: string type: array tcp_rules: description: 'For TCP applications, this dictionary will include information - on client & server prefix filters, server & client ports, DCSP settings. + on client & server prefix filters, server & client ports, and DCSP settings. ' items: 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 @@ -322,19 +270,13 @@ components: items: type: object type: array - use_parentapp_network_policy: - description: 'If enabled, policy rule defined for the parent application - will be used to make routing decisions for this app. - - ' - type: boolean required: - app_type - transfer_type - display_name - ingress_traffic_pct - path_affinity - AppDefQueryFilterTransformedV2N4: + AppDefQueryFilterTransformedV2N3: properties: abbreviation: description: 'Abbreviation of the application name. @@ -342,7 +284,9 @@ components: ' type: string aggregate_flows: - description: "Aggregate flows enabled. True / False. \n" + description: 'The aggregate flows. + + ' type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined @@ -351,7 +295,7 @@ components: ' type: string app_unreachability_detection: - description: 'Aggregate reachability detection. True / False. + description: 'Application unreachability detection. ' type: boolean @@ -443,10 +387,8 @@ components: ' type: string ingress_traffic_pct: - description: '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: @@ -470,8 +412,8 @@ components: ' type: boolean order_number: - description: "The order number. Order number should be between 1-65535L.\ - \ \n" + description: "The app config order number. Order number should be between\ + \ 1-65535. \n" format: int32 type: integer overrides_allowed: @@ -480,17 +422,6 @@ components: ' type: boolean - p_category: - description: 'Parent app category. - - ' - type: string - p_parent_id: - description: P Parent Id - type: string - p_sub_category: - description: "Parent app sub-category. \n" - type: string parent_id: description: 'Parent app ID. @@ -513,14 +444,6 @@ components: ' format: int32 type: integer - supported_engines: - description: "Supported engines values. \n" - enum: - - ave - - ave-all - - panos - - all - type: string system_app_overridden: description: 'If true, it indicates the an application override has been added. @@ -568,29 +491,19 @@ components: - display_name - ingress_traffic_pct - path_affinity - AppDefScreenV2N4: + AppDefScreenV2: properties: abbreviation: description: 'Abbreviation of the application name. ' type: string - aggregate_flows: - description: 'The aggregate flows. - - ' - type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined applications are not allowed to be edited using appdefs. ' type: string - app_unreachability_detection: - description: 'Application unreachability detection. - - ' - type: boolean category: description: 'The application category. @@ -652,16 +565,10 @@ components: ' format: int32 type: integer - description: - description: 'Description for the application. Max size = 256. - - ' display_name: - description: 'This is the name of the application that is visible on the - Controller UI. Application display name is required and cannot be null. - Max size = 64. - - ' + description: "This is the name of the application that is visible on the\ + \ Controller UI. Application display name is required and cannot be null.\ + \ Max size = 64. \n" type: string domains: description: 'Applicable for layer 7 applications. List of application domains. @@ -674,66 +581,14 @@ components: type: string type: array id: - description: 'Application ID. - - ' + description: "Application ID. \n" type: string ingress_traffic_pct: - description: 'The app def ingress traffic. Application ingress traffic percentage - should be in between 1-99. - - ' - format: int32 - type: integer - ip_rules: - description: 'Applicable for L3/L4 applications. These are IP Prefix rules - used to identify the application viz protocol, dscp, source & destination - prefixes and source & destination prefixes. - - ' - items: - type: object - type: array - is_deprecated: - description: 'Deprecated application definitions. - - ' - type: boolean - network_scan_application: - description: 'If true, it enables Network Scan App to designate custom applications - as network scan applications. - - ' - type: boolean - order_number: - description: "The app config order number. Order number should be between\ - \ 1-65535. \n" + description: 'Ingress Traffic Pct: Required(message = required) DecimalMin(inclusive + = true, APPDEF_CONFIG_INGRESS_MIN, value = 1) DecimalMax(inclusive = true, + APPDEF_CONFIG_INGRESS_MAX, value = 99) ' format: int32 type: integer - overrides_allowed: - description: 'If true, this enables an update to be added using the appdef_overrides - API. - - ' - type: boolean - p_category: - description: 'Parent app category. - - ' - type: string - p_parent_id: - description: P Parent Id - type: string - p_sub_category: - description: 'Parent app sub-category. - - ' - type: string - parent_id: - description: 'Parent app ID. - - ' - type: string path_affinity: description: "This parameter defines the path affinity characteristics to\ \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ @@ -745,44 +600,12 @@ components: - weak - strict type: string - session_timeout: - description: 'Application session timeout should be in between 0-44000. - - ' - format: int32 - type: integer - supported_engines: - description: 'Supported engines. - - ' - enum: - - ave - - ave-all - - panos - - all - type: string - system_app_overridden: - description: 'If true, it indicates the an application override has been - added. - - ' - type: boolean - tags: - description: 'A information field that can be added to identify the application. - Maximum 10 Unique tags of length 1024 each are allowed. - - ' - items: - description: Tags - type: string - type: array tcp_rules: - description: 'For TCP applications, this dictionary will include information - on client & server prefix filters, server & client ports, DCSP settings. - - ' + description: "For TCP applications, this dictionary will include information\ + \ on client & server prefix filters, server & client ports, and DCSP settings.\ + \ \n" items: - type: string + $ref: '#/components/schemas/TcpRule' type: array transfer_type: description: "Application transfer type. Allowed values: transactional,\ @@ -794,21 +617,16 @@ components: ' items: - type: object + $ref: '#/components/schemas/UdpRule' type: array - use_parentapp_network_policy: - description: 'If enabled, policy rule defined for the parent application - will be used to make routing decisions for this app. - - ' - type: boolean required: + - category - app_type - transfer_type - display_name - ingress_traffic_pct - path_affinity - AppDefScreenV2N5: + AppDefScreenV2N1: properties: abbreviation: description: 'Abbreviation of the application name. @@ -816,9 +634,7 @@ components: ' type: string aggregate_flows: - description: 'Aggregate flows enabled. True / False. - - ' + description: Aggregate Flows type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined @@ -826,11 +642,6 @@ components: ' type: string - app_unreachability_detection: - description: 'Aggregate reachability detection. True / False. - - ' - type: boolean category: description: 'The application category. @@ -897,11 +708,10 @@ components: ' display_name: - description: 'This is the name of the application that is visible on the - Controller UI. Application display name is required and cannot be null. - Max size = 64. - - ' + description: 'Display Name: NotBlank(error = APPDEF_CONFIG_INVALID_DISPLAYNAME: + Application display name is required and cannot be null.) Size(max = 64, + error = APPDEF_CONFIG_INVALID_DISPLAYNAME: Application display name is + required and cannot be null., min = 0) ' type: string domains: description: 'Applicable for layer 7 applications. List of application domains. @@ -919,10 +729,11 @@ components: ' type: string ingress_traffic_pct: - description: 'Application ingress traffic percentage should be in between - 1-99. - - ' + 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) ' format: int32 type: integer ip_rules: @@ -934,20 +745,9 @@ components: items: type: object type: array - is_deprecated: - description: 'Deprecated application definitions. - - ' - type: boolean - network_scan_application: - description: 'If true, it enables Network Scan App to designate custom applications - as network scan applications. - - ' - type: boolean order_number: - description: "The order number. Order number should be between 1-65535L.\ - \ \n" + 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: @@ -956,28 +756,14 @@ components: ' type: boolean - p_category: - description: 'Parent app category. + path_affinity: + description: 'This parameter defines the path affinity characteristics to + consider during flow decision making. Allowed values: "none" "weak" "strict". + If path affinity is none or weak and a better path is available, flows + will be moved to a new path. If path affinity is strict, all application + flows will continue on the same path. ' - type: string - p_parent_id: - description: P Parent Id - type: string - p_sub_category: - description: 'Parent app sub-category. - - ' - type: string - parent_id: - description: "Parent app ID. \n" - type: string - path_affinity: - description: "This parameter defines the path affinity characteristics to\ - \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ - \ \"strict\". If path affinity is none or weak and a better path is available,\ - \ flows will be moved to a new path. If path affinity is strict, all application\ - \ flows will continue on the same path. \n" enum: - none - weak @@ -989,16 +775,6 @@ components: ' format: int32 type: integer - supported_engines: - description: 'Supported engines values. - - ' - enum: - - ave - - ave-all - - panos - - all - type: string system_app_overridden: description: 'If true, it indicates the an application override has been added. @@ -1023,8 +799,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 @@ -1034,87 +812,31 @@ components: items: type: object type: array - use_parentapp_network_policy: - description: 'If enabled, policy rule defined for the parent application - will be used to make routing decisions for this app. - - ' - type: boolean required: - app_type - transfer_type - display_name - ingress_traffic_pct - path_affinity - AppDefTenantVersion: - properties: - app_version: - description: 'Version of the app. - - ' - type: string - disabled: - description: 'Disable the app. - - ' - type: boolean - disabled_reason: - description: 'Reason to disable the app. - - ' - type: string - id: - description: 'Application ID. - - ' - type: string - inactive: - description: 'App status (active or inactive). - - ' - type: boolean - inactive_reason: - description: 'Reason for app being inactive. - - ' - type: string - region: - description: 'App region. - - ' - type: string - reqState: - description: 'App states. - - ' - enum: - - APPDEF_APPS_REQ_PENDING - - APPDEF_APPS_CREATE_IN_PROGRESS - - APPDEF_CODECS_CREATE_IN_PROGRESS - - APPDEF_CREATE_COMPLETE - - APPDEF_CREATE_FAILED - type: string - sigfile_url: - description: 'URL of the sigfile. - - ' - type: string - uApp_version: - description: UApp Version - type: string - AppDefV2: + AppDefScreenV2N2: properties: abbreviation: description: 'Abbreviation of the application name. ' type: string + aggregate_flows: + description: Aggregate Flows + type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined applications are not allowed to be edited using appdefs. ' type: string + app_unreachability_detection: + description: App Unreachability Detection + type: boolean category: description: 'The application category. @@ -1176,6 +898,10 @@ components: ' format: int32 type: integer + description: + description: 'Description for the application. Max size = 256. + + ' display_name: description: 'This is the name of the application that is visible on the Controller UI. Application display name is required and cannot be null. @@ -1199,12 +925,49 @@ components: ' type: string ingress_traffic_pct: - description: 'The app def config ingress traffic pct values. (Min value - = 1, Max value = 99). + 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) ' + format: int32 + type: integer + ip_rules: + description: 'Applicable for L3/L4 applications. These are IP Prefix rules + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. + + ' + items: + type: object + type: array + is_deprecated: + description: 'Deprecated application definitions. + + ' + type: boolean + network_scan_application: + description: 'If true, it enables Network Scan App to designate custom applications + as network scan applications. ' + 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) ' format: int32 type: integer + overrides_allowed: + description: 'If true, this enables an update to be added using the appdef_overrides + API. + + ' + type: boolean + parent_id: + description: 'Parent app ID. + + ' + type: string path_affinity: description: "This parameter defines the path affinity characteristics to\ \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ @@ -1216,13 +979,34 @@ components: - weak - strict type: string + session_timeout: + description: 'Application session timeout should be in between 0-44000. + + ' + format: int32 + type: integer + system_app_overridden: + description: 'If true, it indicates the an application override has been + added. + + ' + type: boolean + 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) ' + items: + description: Tags + type: string + type: array tcp_rules: description: 'For TCP applications, this dictionary will include information on client & server prefix filters, server & client ports, DCSP settings. ' items: - $ref: '#/components/schemas/TcpRule' + type: string type: array transfer_type: description: "Application transfer type. Allowed values: transactional,\ @@ -1234,16 +1018,21 @@ components: ' items: - $ref: '#/components/schemas/UdpRule' + type: object type: array + use_parentapp_network_policy: + description: 'If enabled, policy rule defined for the parent application + will be used to make routing decisions for this app. + + ' + type: boolean required: - - category - app_type - transfer_type - display_name - ingress_traffic_pct - path_affinity - AppDefV2N4: + AppDefScreenV2N3: properties: abbreviation: description: 'Abbreviation of the application name. @@ -1251,9 +1040,7 @@ components: ' type: string aggregate_flows: - description: 'The aggregate flows. - - ' + description: Aggregate Flows type: boolean app_type: description: 'Type of application. Allowed values: custom. System defined @@ -1262,9 +1049,7 @@ components: ' type: string app_unreachability_detection: - description: 'Application unreachability detection. - - ' + description: App Unreachability Detection type: boolean category: description: 'The application category. @@ -1354,10 +1139,11 @@ components: ' type: string ingress_traffic_pct: - description: 'The app def ingress traffic. Application ingress traffic percentage - should be in between 1-99. - - ' + 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) ' format: int32 type: integer ip_rules: @@ -1381,10 +1167,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: @@ -1393,19 +1177,6 @@ components: ' type: boolean - p_category: - description: 'Parent app category. - - ' - type: string - p_parent_id: - description: P Parent Id - type: string - p_sub_category: - description: 'Parent app sub-category. - - ' - type: string parent_id: description: 'Parent app ID. @@ -1428,14 +1199,6 @@ components: ' format: int32 type: integer - supported_engines: - description: "Supported engines. \n" - enum: - - ave - - ave-all - - panos - - all - type: string system_app_overridden: description: 'If true, it indicates the an application override has been added. @@ -1483,7 +1246,7 @@ components: - display_name - ingress_traffic_pct - path_affinity - AppDefV2N5: + AppDefScreenV2N4: properties: abbreviation: description: 'Abbreviation of the application name. @@ -1621,10 +1384,8 @@ components: ' type: boolean order_number: - description: 'The app config order number. Order number should be between - 1-65535. - - ' + description: "The app config order number. Order number should be between\ + \ 1-65535. \n" format: int32 type: integer overrides_allowed: @@ -1669,7 +1430,9 @@ components: format: int32 type: integer supported_engines: - description: "Supported engines. \n" + description: 'Supported engines. + + ' enum: - ave - ave-all @@ -1723,29 +1486,86 @@ components: - display_name - ingress_traffic_pct - path_affinity - AppdefOverrideScreenV2N2: + AppDefTenantVersion: properties: - aggregate_flows: - description: 'The aggregate flows. + app_version: + description: 'Version of the app. + + ' + type: string + disabled: + description: 'Disable the app. ' type: boolean - app_unreachability_detection: - description: 'Application unreachability detection. + disabled_reason: + description: 'Reason to disable the app. + + ' + type: string + id: + description: 'Application ID. + + ' + type: string + inactive: + description: 'App status (active or inactive). ' type: boolean - category: - description: 'The application category. + inactive_reason: + description: 'Reason for app being inactive. + + ' + type: string + region: + description: 'App region. + + ' + type: string + reqState: + description: 'App states. ' enum: - - anonymity - - anti-virus - - auth - - backup - - cad - - collaboration + - APPDEF_APPS_REQ_PENDING + - APPDEF_APPS_CREATE_IN_PROGRESS + - APPDEF_CODECS_CREATE_IN_PROGRESS + - APPDEF_CREATE_COMPLETE + - APPDEF_CREATE_FAILED + type: string + sigfile_url: + description: 'URL of the sigfile. + + ' + type: string + uApp_version: + description: UApp Version + type: string + AppDefV2: + properties: + abbreviation: + description: 'Abbreviation of the application name. + + ' + type: string + app_type: + description: 'Type of application. Allowed values: custom. System defined + applications are not allowed to be edited using appdefs. + + ' + type: string + category: + description: 'The application category. + + ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration - conference - crm - db-mgmt @@ -1794,11 +1614,15 @@ components: be in between 0-44000. ' + format: int32 type: integer - description: - description: 'Description for the application. Max size = 256. + display_name: + description: 'This is the name of the application that is visible on the + Controller UI. Application display name is required and cannot be null. + Max size = 64. ' + type: string domains: description: 'Applicable for layer 7 applications. List of application domains. Maximum 16 valid domains are allowed and each domain should not exceed @@ -1815,77 +1639,30 @@ 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). ' + format: int32 type: integer - ip_rules: - description: 'Applicable for L3/L4 applications. These are IP Prefix rules - used to identify the application viz protocol, dscp, source & destination - prefixes and source & destination prefixes. - - ' - items: - $ref: '#/components/schemas/IPRuleV2' - type: array - override_default_ip_rules: - description: 'The default override IP rules. - - ' - type: boolean - override_default_tcp_rules: - description: 'The default override TCP rules. - - ' - type: boolean - override_default_udp_rules: - description: 'The default override UDP rules. - - ' - type: boolean - override_domains: - description: 'List the override domains. - - ' - type: boolean - overrides_disable: - description: 'List the disabled overrides. - - ' - type: boolean path_affinity: description: "This parameter defines the path affinity characteristics to\ \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ \ \"strict\". If path affinity is none or weak and a better path is available,\ \ flows will be moved to a new path. If path affinity is strict, all application\ - \ flows will continue on the same path. \n" + \ flows will continue on the same path. \n" enum: - none - weak - strict type: string - session_timeout: - description: 'Application session timeout should be in between 0-44000. - - ' - type: integer - tags: - description: 'A information field that can be added to identify the application. - Maximum 10 Unique tags of length 1024 each are allowed. - - ' - items: - description: Tags - type: string - type: array tcp_rules: description: 'For TCP applications, this dictionary will include information on client & server prefix filters, server & client ports, DCSP settings. ' items: - $ref: '#/components/schemas/TcpRuleV2' + $ref: '#/components/schemas/TcpRule' type: array transfer_type: description: "Application transfer type. Allowed values: transactional,\ @@ -1897,26 +1674,31 @@ components: ' items: - $ref: '#/components/schemas/UdpRuleV2' + $ref: '#/components/schemas/UdpRule' type: array - use_parentapp_network_policy: - description: 'If enabled, policy rule defined for the parent application - will be used to make routing decisions for this app. - - ' - type: boolean - AppdefOverrideScreenV2N3: + required: + - category + - app_type + - transfer_type + - display_name + - ingress_traffic_pct + - path_affinity + AppDefV2N1: properties: - aggregate_flows: - description: 'The aggregate flows. + abbreviation: + description: 'Abbreviation of the application name. ' + type: string + aggregate_flows: + description: Aggregate Flows type: boolean - app_unreachability_detection: - description: 'Application unreachability detection. + app_type: + description: 'Type of application. Allowed values: custom. System defined + applications are not allowed to be edited using appdefs. ' - type: boolean + type: string category: description: 'The application category. @@ -1976,11 +1758,18 @@ components: be in between 0-44000. ' + format: int32 type: integer description: description: 'Description for the application. Max size = 256. ' + display_name: + description: 'Display Name: NotBlank(error = APPDEF_CONFIG_INVALID_DISPLAYNAME: + Application display name is required and cannot be null.) Size(max = 64, + error = APPDEF_CONFIG_INVALID_DISPLAYNAME: Application display name is + required and cannot be null., min = 0) ' + type: string domains: description: 'Applicable for layer 7 applications. List of application domains. Maximum 16 valid domains are allowed and each domain should not exceed @@ -1997,10 +1786,12 @@ components: ' type: string ingress_traffic_pct: - description: 'The app def ingress traffic. Application ingress traffic percentage - should be in between 1-99. - - ' + 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) ' + format: int32 type: integer ip_rules: description: 'Applicable for L3/L4 applications. These are IP Prefix rules @@ -2009,52 +1800,28 @@ components: ' items: - $ref: '#/components/schemas/IPRuleV2' + type: object type: array - override_default_ip_rules: - description: 'The default override IP rules. - - ' - type: boolean - override_default_tcp_rules: - description: 'The default override TCP rules. - - ' - type: boolean - override_default_udp_rules: - description: 'The default override UDP rules. - - ' - type: boolean - override_domains: - description: 'List the override domains. - - ' - type: boolean - overrides_disable: - description: 'List the disabled overrides. + order_number: + 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: + description: 'If true, this enables an update to be added using the appdef_overrides + API. ' type: boolean - p_category: - description: 'Parent App Category + path_affinity: + description: 'This parameter defines the path affinity characteristics to + consider during flow decision making. Allowed values: "none" "weak" "strict". + If path affinity is none or weak and a better path is available, flows + will be moved to a new path. If path affinity is strict, all application + flows will continue on the same path. ' enum: - - business-systems - - collaboration - - general-internet - - media - - networking - - saas - type: string - path_affinity: - description: "This parameter defines the path affinity characteristics to\ - \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ - \ \"strict\". If path affinity is none or weak and a better path is available,\ - \ flows will be moved to a new path. If path affinity is strict, all application\ - \ flows will continue on the same path. \n" - enum: - none - weak - strict @@ -2063,7 +1830,14 @@ components: description: 'Application session timeout should be in between 0-44000. ' + format: int32 type: integer + system_app_overridden: + description: 'If true, it indicates the an application override has been + added. + + ' + type: boolean tags: description: 'A information field that can be added to identify the application. Maximum 10 Unique tags of length 1024 each are allowed. @@ -2079,11 +1853,13 @@ components: ' items: - $ref: '#/components/schemas/TcpRuleV2' + 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 @@ -2091,25 +1867,32 @@ components: ' items: - $ref: '#/components/schemas/UdpRuleV2' + type: object type: array - use_parentapp_network_policy: - description: 'If enabled, policy rule defined for the parent application - will be used to make routing decisions for this app. - - ' - type: boolean - AppdefOverrideV2N2: + required: + - app_type + - transfer_type + - display_name + - ingress_traffic_pct + - path_affinity + AppDefV2N2: properties: - aggregate_flows: - description: 'The aggregate flows. + abbreviation: + description: 'Abbreviation of the application name. ' + type: string + aggregate_flows: + description: Aggregate Flows type: boolean - app_unreachability_detection: - description: 'Application unreachability detection. + app_type: + description: 'Type of application. Allowed values: custom. System defined + applications are not allowed to be edited using appdefs. ' + type: string + app_unreachability_detection: + description: App Unreachability Detection type: boolean category: description: 'The application category. @@ -2170,11 +1953,19 @@ components: be in between 0-44000. ' + format: int32 type: integer description: - description: 'Description for the application. Max size = 256. + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + display_name: + description: 'This is the name of the application that is visible on the + Controller UI. Application display name is required and cannot be null. + Max size = 64. ' + type: string domains: description: 'Applicable for layer 7 applications. List of application domains. Maximum 16 valid domains are allowed and each domain should not exceed @@ -2191,10 +1982,12 @@ components: ' type: string ingress_traffic_pct: - description: 'The app def ingress traffic. Application ingress traffic percentage - should be in between 1-99. - - ' + 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) ' + format: int32 type: integer ip_rules: description: 'Applicable for L3/L4 applications. These are IP Prefix rules @@ -2203,39 +1996,41 @@ components: ' items: - $ref: '#/components/schemas/IPRuleV2' + type: object type: array - override_default_ip_rules: - description: 'The default override IP rules. + is_deprecated: + description: 'Deprecated application definitions. ' type: boolean - override_default_tcp_rules: - description: 'The default override TCP rules. + network_scan_application: + description: 'If true, it enables Network Scan App to designate custom applications + as network scan applications. ' type: boolean - override_default_udp_rules: - description: 'The default override UDP rules. - - ' - type: boolean - override_domains: - description: 'List the override domains. + order_number: + 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: + description: 'If true, this enables an update to be added using the appdef_overrides + API. ' type: boolean - overrides_disable: - description: 'List the disabled overrides. + parent_id: + description: 'Parent app ID. ' - type: boolean + type: string path_affinity: description: "This parameter defines the path affinity characteristics to\ \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ \ \"strict\". If path affinity is none or weak and a better path is available,\ \ flows will be moved to a new path. If path affinity is strict, all application\ - \ flows will continue on the same path. \n" + \ flows will continue on the same path. \n" enum: - none - weak @@ -2245,12 +2040,19 @@ components: description: 'Application session timeout should be in between 0-44000. ' + format: int32 type: integer - tags: - description: 'A information field that can be added to identify the application. - Maximum 10 Unique tags of length 1024 each are allowed. + system_app_overridden: + description: 'If true, it indicates the an application override has been + added. ' + type: boolean + 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) ' items: description: Tags type: string @@ -2261,7 +2063,7 @@ components: ' items: - $ref: '#/components/schemas/TcpRuleV2' + type: string type: array transfer_type: description: "Application transfer type. Allowed values: transactional,\ @@ -2273,7 +2075,7 @@ components: ' items: - $ref: '#/components/schemas/UdpRuleV2' + type: object type: array use_parentapp_network_policy: description: 'If enabled, policy rule defined for the parent application @@ -2281,11 +2083,28 @@ components: ' type: boolean - AppdefOverrideV2N3: + required: + - app_type + - transfer_type + - display_name + - ingress_traffic_pct + - path_affinity + AppDefV2N3: properties: + abbreviation: + description: 'Abbreviation of the application name. + + ' + type: string aggregate_flows: description: Aggregate Flows type: boolean + app_type: + description: 'Type of application. Allowed values: custom. System defined + applications are not allowed to be edited using appdefs. + + ' + type: string app_unreachability_detection: description: App Unreachability Detection type: boolean @@ -2348,11 +2167,19 @@ components: be in between 0-44000. ' + format: int32 type: integer description: description: 'Description for the application. Max size = 256. ' + display_name: + description: 'This is the name of the application that is visible on the + Controller UI. Application display name is required and cannot be null. + Max size = 64. + + ' + type: string domains: description: 'Applicable for layer 7 applications. List of application domains. Maximum 16 valid domains are allowed and each domain should not exceed @@ -2369,9 +2196,12 @@ 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: '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) ' + format: int32 type: integer ip_rules: description: 'Applicable for L3/L4 applications. These are IP Prefix rules @@ -2380,51 +2210,41 @@ components: ' items: - $ref: '#/components/schemas/IPRuleV2' + type: object type: array - override_default_ip_rules: - description: 'The default override IP rules. - - ' - type: boolean - override_default_tcp_rules: - description: 'The default override TCP rules. - - ' - type: boolean - override_default_udp_rules: - description: 'The default override UDP rules. + is_deprecated: + description: 'Deprecated application definitions. ' type: boolean - override_domains: - description: 'List the override domains. + network_scan_application: + description: 'If true, it enables Network Scan App to designate custom applications + as network scan applications. ' type: boolean - overrides_disable: - description: 'List the disabled overrides. + order_number: + 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: + description: 'If true, this enables an update to be added using the appdef_overrides + API. ' type: boolean - p_category: - description: 'Parent App Category + parent_id: + description: 'Parent app ID. ' - enum: - - business-systems - - collaboration - - general-internet - - media - - networking - - saas type: string path_affinity: description: "This parameter defines the path affinity characteristics to\ \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ \ \"strict\". If path affinity is none or weak and a better path is available,\ \ flows will be moved to a new path. If path affinity is strict, all application\ - \ flows will continue on the same path. \n" + \ flows will continue on the same path. \n" enum: - none - weak @@ -2434,7 +2254,14 @@ components: description: 'Application session timeout should be in between 0-44000. ' + format: int32 type: integer + system_app_overridden: + description: 'If true, it indicates the an application override has been + added. + + ' + type: boolean tags: description: 'A information field that can be added to identify the application. Maximum 10 Unique tags of length 1024 each are allowed. @@ -2450,7 +2277,7 @@ components: ' items: - $ref: '#/components/schemas/TcpRuleV2' + type: string type: array transfer_type: description: "Application transfer type. Allowed values: transactional,\ @@ -2462,7 +2289,7 @@ components: ' items: - $ref: '#/components/schemas/UdpRuleV2' + type: object type: array use_parentapp_network_policy: description: 'If enabled, policy rule defined for the parent application @@ -2470,607 +2297,3234 @@ components: ' type: boolean - BulkResponse: + required: + - app_type + - transfer_type + - display_name + - ingress_traffic_pct + - path_affinity + AppDefV2N4: properties: - count: - description: 'The total number. + abbreviation: + description: 'Abbreviation of the application name. ' - format: int32 - type: integer - id: - description: 'The ID. + type: string + aggregate_flows: + description: 'The aggregate flows. + + ' + type: boolean + app_type: + description: 'Type of application. Allowed values: custom. System defined + applications are not allowed to be edited using appdefs. ' type: string - type: - description: "The type. \n" + app_unreachability_detection: + description: 'Application unreachability detection. + + ' + type: boolean + category: + description: 'The application category. + + ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default type: string - DSCP: - properties: - value: - description: 'The DSCP value. + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. ' format: int32 type: integer - Error: - properties: - _error: - items: - $ref: '#/components/schemas/ErrorResponse' - type: array - ErrorResponse: - properties: - code: - description: 'The error code. + description: + description: 'Description for the application. Max size = 256. ' - type: string - message: - description: 'The error message. + display_name: + description: 'This is the name of the application that is visible on the + Controller UI. Application display name is required and cannot be null. + Max size = 64. ' type: string - Filter: - properties: - elements: - description: 'Elements of the filter. - - ' - items: - description: Elements - type: string - type: array - path: - description: 'Path of the filter. + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. ' items: - description: Path + description: Domains type: string type: array - site: - description: 'Site of the filter. + id: + description: 'Application ID. ' - type: object - type: - description: 'Type of the filter. + type: string + ingress_traffic_pct: + description: 'The app def ingress traffic. Application ingress traffic percentage + should be in between 1-99. ' - type: string - GlobalPrefixFilter: - properties: - description: - description: 'Description for the global prefix filter. + format: int32 + type: integer + ip_rules: + description: 'Applicable for L3/L4 applications. These are IP Prefix rules + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. ' - filters: - description: 'Filters: Required(PREFIXFILTER_REQUIRED) Valid ' items: - $ref: '#/components/schemas/Filter' + type: object type: array - id: - description: 'ID of the global prefix filter. + is_deprecated: + description: 'Deprecated application definitions. ' - type: string - name: - description: 'Name of the global prefix filters. + type: boolean + network_scan_application: + description: 'If true, it enables Network Scan App to designate custom applications + as network scan applications. ' - type: string - required: - - filters - - name - GlobalPrefixFilterScreen: - properties: - description: - description: 'Description for the global prefix filter. + type: boolean + order_number: + description: 'The app config order number. Order number should be between + 1-65535. ' - filters: - description: 'List the filters. + format: int32 + type: integer + overrides_allowed: + description: 'If true, this enables an update to be added using the appdef_overrides + API. ' - items: - $ref: '#/components/schemas/Filter' - type: array - id: - description: 'ID of the global prefix filter. + type: boolean + p_category: + description: 'Parent app category. ' type: string - name: - description: 'Name of the global prefix filters. + p_parent_id: + description: P Parent Id + type: string + p_sub_category: + description: 'Parent app sub-category. ' type: string - required: - - filters - - name - GlobalPrefixQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of global prefixes that match the query - parameters. + parent_id: + description: 'Parent app ID. ' - dest_page: - description: 'The destination page. + type: string + path_affinity: + description: "This parameter defines the path affinity characteristics to\ + \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ + \ \"strict\". If path affinity is none or weak and a better path is available,\ + \ flows will be moved to a new path. If path affinity is strict, all application\ + \ flows will continue on the same path. \n" + enum: + - none + - weak + - strict + type: string + session_timeout: + description: 'Application session timeout should be in between 0-44000. ' format: int32 type: integer - getDeleted: - description: 'The number global prefixes deleted for a time frame. + supported_engines: + description: "Supported engines. \n" + enum: + - ave + - ave-all + - panos + - all + type: string + system_app_overridden: + description: 'If true, it indicates the an application override has been + added. ' type: boolean - group_by: - description: 'Group the global prefixs for the query. + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. ' items: - description: Group By + description: Tags type: string type: array - id: - description: "Lists the global prefixes 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. + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. + items: + type: string + type: array + transfer_type: + description: "Application transfer type. Allowed values: transactional,\ + \ bulk, rt-audio, rt-video. \n" + type: string + udp_rules: + description: 'For UDP applications, this dictionary will include information + on UDP port, DCSP settings, UDP Filters and destination prefixes. ' items: - description: Retrieved Fields - type: string + type: object type: array - retrieved_fields_mask: - description: 'List the fields to query. + use_parentapp_network_policy: + description: 'If enabled, policy rule defined for the parent application + will be used to make routing decisions for this app. ' type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. + required: + - app_type + - transfer_type + - display_name + - ingress_traffic_pct + - path_affinity + AppdefOverride: + properties: + aggregate_flows: + description: Aggregate Flows + type: boolean + category: + description: 'Category: ValidateEnum(enumClass = classOf[AppCategory], error + = APPDEF_CONFIG_INVALID_CATEGORY: Application category is invalid., nullAllowed + = true) ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default + type: string + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. ' - format: int64 type: integer - GlobalPrefixQueryFilter: - properties: description: - description: 'The description of the security policy global prefix. Max - size = 256. - - ' - id: - description: 'The ID of the security policy global prefix. + description: 'Description for the application. Max size = 256. ' - type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the security policy global prefix. + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. ' items: - description: Ipv4 Prefixes + description: Domains type: string type: array - name: - description: 'The name of the security policy global prefix. Max size = - 128. + id: + description: 'Application ID. ' 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. + 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) ' + type: integer + ip_rules: + description: 'Applicable for L3/L4 applications. These are IP Prefix rules + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. ' items: - description: Tags - type: string + $ref: '#/components/schemas/IPRuleV1' type: array - required: - - name - IPRuleV2: - properties: - dest_filters: - description: 'The app def destination filter list. Max size = 8. - - ' - items: - description: Dest Filters - 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) ' - items: - description: Dest Prefixes - type: string - type: array - dscp: - $ref: '#/components/schemas/DSCP' - description: 'The DSP value. + override_default_ip_rules: + description: 'The default override IP rules. ' - protocol: - description: 'The app def protocols. + type: boolean + override_default_tcp_rules: + description: 'The default override TCP rules. ' - enum: - - ospf - - ipv6 - - is-is-over-ipv4 - - ipv6-nonxt - - etherip - - ipv6-icmp - - igmp - - udplite - - ipv6-opts - - icmp - - esp - - crtp - - ipip - - eigrp - - egp - - gre - - l2tpv3 - - sctp - - ip-in-ip - - rsvp - - pim - - scps - - mpls-in-ip - - ah - - vrrp - - ipv6-route - - igp - - ipv6-frag - type: string - src_filters: - description: 'The app def src filters list. Max size = 8. + type: boolean + override_default_udp_rules: + description: 'The default override UDP rules. ' - items: - description: Src Filters - type: string - type: array - required: - - protocol - ListQueryResponse: - properties: - count: - description: 'The actual count. + type: boolean + override_domains: + description: Override Domains + type: boolean + overrides_disable: + description: Overrides Disable + type: boolean + path_affinity: + description: 'This parameter defines the path affinity characteristics to + consider during flow decision making. Allowed values: "none" "weak" "strict". + If path affinity is none or weak and a better path is available, flows + will be moved to a new path. If path affinity is strict, all application + flows will continue on the same path. ' - format: int32 - type: integer - deleted_count: - description: 'The deleted number. + enum: + - none + - weak + - strict + type: string + session_timeout: + description: 'Application session timeout should be in between 0-44000. ' - format: int64 type: integer - deleted_ids: - description: 'The deleted IDs. + tags: + description: 'A information field that can be added to identify the application. + 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. + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. ' - id: - description: 'The ID. + items: + $ref: '#/components/schemas/TcpRuleV1' + type: array + transfer_type: + description: 'Application transfer type. Allowed values: transactional, + bulk, rt-audio, rt-video. ' type: string - next_query: - description: 'Details of the next query. + udp_rules: + description: 'For UDP applications, this dictionary will include information + on UDP port, DCSP settings, UDP Filters and destination prefixes. ' - type: object - total_count: - description: 'Total number. + items: + $ref: '#/components/schemas/UdpRuleV1' + type: array + AppdefOverrideScreen: + properties: + aggregate_flows: + description: Aggregate Flows + type: boolean + category: + description: 'Category: ValidateEnum(enumClass = classOf[AppCategory], error + = APPDEF_CONFIG_INVALID_CATEGORY: Application category is invalid., nullAllowed + = true) ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default + type: string + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. ' - format: int64 type: integer - type: object - LocalPrefixFilter: - properties: description: - description: 'Description of the local prefix filter. - - ' - id: - description: 'Id of the local prefix filter. - - ' - type: string - name: - description: 'Name of the local prefix filter. + description: 'Description for the application. Max size = 256. ' - type: string - required: - - name - LocalPrefixFilterScreen: - properties: - description: - description: 'Description of the local prefix filter. + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. ' + items: + description: Domains + type: string + type: array id: - description: 'ID of the local prefix filter. + description: 'Application ID. ' type: string - name: - description: 'Name of the local prefix filter. + 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) ' + type: integer + ip_rules: + description: 'Applicable for L3/L4 applications. These are IP Prefix rules + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. ' - type: string - required: - - name - LocalPrefixQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of app defs that match the query parameters. + items: + $ref: '#/components/schemas/IPRuleV1' + type: array + override_default_ip_rules: + description: 'The default override IP rules. ' - dest_page: - description: 'The destination page. + type: boolean + override_default_tcp_rules: + description: 'The default override TCP rules. ' - format: int32 - type: integer - getDeleted: - description: 'The number app definitions deleted for a time frame. + type: boolean + override_default_udp_rules: + description: 'The default override UDP rules. ' type: boolean - group_by: - description: 'Group the app definitions for the query. + override_domains: + description: Override Domains + type: boolean + overrides_disable: + description: Overrides Disable + type: boolean + path_affinity: + description: 'This parameter defines the path affinity characteristics to + consider during flow decision making. Allowed values: "none" "weak" "strict". + If path affinity is none or weak and a better path is available, flows + will be moved to a new path. If path affinity is strict, all application + flows will continue on the same path. ' - items: - description: Group By - type: string - type: array - id: - description: "List the app definitions by ID. \n" + enum: + - none + - weak + - strict 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. + session_timeout: + description: 'Application session timeout should be in between 0-44000. ' - format: int32 type: integer - next_query: - description: 'List the next query. + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. + items: + description: Tags + type: string + type: array + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. ' items: - description: Retrieved Fields - type: string + $ref: '#/components/schemas/TcpRuleV1' type: array - retrieved_fields_mask: - description: 'List the marked fields to query. + transfer_type: + description: 'Application transfer type. Allowed values: transactional, + bulk, rt-audio, rt-video. ' - type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. + type: string + udp_rules: + description: 'For UDP applications, this dictionary will include information + on UDP port, DCSP settings, UDP Filters and destination prefixes. ' - format: int64 - type: integer - Port: + items: + $ref: '#/components/schemas/UdpRuleV1' + type: array + AppdefOverrideScreenV2N1: properties: - end: - description: 'The end port range must be between 1 and 65535. + aggregate_flows: + description: Aggregate Flows + type: boolean + app_unreachability_detection: + description: App Unreachability Detection + type: boolean + category: + description: 'Application category. Allowed values: ""anonymity"" ""anti-virus"" + ""auth"" ""backup"" ""cad"" ""collaboration"" ""conference"" ""crm"" ""db-mgmt"" + ""email"" ""enterprise"" ""file-sharing"" ""file-system"" ""file-transfer"" + ""gaming"" ""intercomm"" ""logging"" ""management"" ""messaging"" ""net-discovery"" + ""net-mgmt"" ""net-monitor"" ""news-server"" ""notification"" ""p2p"" + ""printing"" ""proxy"" ""recreational"" ""remote-desk"" ""remote-mgmt"" + ""replication"" ""routing"" ""saas"" ""secure-browsing"" ""storage"" ""streaming"" + ""tunnel"" ""utility"" ""voip"" ""wan-opt"" ""web-browsing"" ""wireless-mgmt"" + ""ip-protocol"" ""multicast"" ""security"" ""i23v5"" ""printer"" ""default""" ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default type: string - start: - description: 'The start port range must be between 1 and 65535. + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. ' - type: string - TcpRule: - properties: - client_filters: - description: 'The app def config IP list. Max size = 8. + type: integer + description: + description: 'Description for the application. Max size = 256. + + ' + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. ' items: - description: Client Filters + description: Domains type: string type: array - client_port: - $ref: '#/components/schemas/Port' - description: 'The start and end client port ranges. + id: + description: 'Application ID. ' - server_filters: - description: 'The app def config IP list. Max size = 8. + 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) ' + type: integer + ip_rules: + description: 'Applicable for L3/L4 applications. These are IP Prefix rules + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. ' items: - description: Server Filters - type: string + $ref: '#/components/schemas/IPRuleV1' type: array - server_port: - $ref: '#/components/schemas/Port' - description: 'The start and end server port ranges. + override_default_ip_rules: + description: 'List the override default IP rules. ' - TcpRuleV2: - properties: - client_filters: - description: 'The app def config IP list. Max size = 8. + type: boolean + override_default_tcp_rules: + description: 'List the override default TCP rules. ' - items: - description: Client Filters - type: string - type: array - client_port: - $ref: '#/components/schemas/Port' - description: 'The start and end client port ranges. + type: boolean + override_default_udp_rules: + description: 'List the override default UDP rules. ' - dscp: - $ref: '#/components/schemas/DSCP' - description: 'The DSP value. + type: boolean + override_domains: + description: 'List the override domains. ' - server_filters: - description: 'The app def config IP list. Max size = 8. + type: boolean + overrides_disable: + description: 'List the disabled overrides. + + ' + type: boolean + path_affinity: + description: 'This parameter defines the path affinity characteristics to + consider during flow decision making. Allowed values: "none" "weak" "strict". + If path affinity is none or weak and a better path is available, flows + will be moved to a new path. If path affinity is strict, all application + flows will continue on the same path. + + ' + enum: + - none + - weak + - strict + type: string + session_timeout: + description: '' + type: integer + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. ' items: - description: Server Filters + description: Tags type: string type: array - server_port: - $ref: '#/components/schemas/Port' - description: 'The start and end server port ranges. + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. ' - 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) ' items: - description: Server Prefixes - type: string + $ref: '#/components/schemas/TcpRuleV1' type: array - UdpRule: - properties: - udp_filters: - description: 'The app def config IP list. Max size = 8. + transfer_type: + description: 'Application transfer type. Allowed values: transactional, + bulk, rt-audio, rt-video. ' + type: string + udp_rules: + description: "Application category. Allowed values: \"\"anonymity\"\" \"\ + \"anti-virus\"\" \"\"auth\"\" \"\"backup\"\" \"\"cad\"\" \"\"collaboration\"\ + \" \"\"conference\"\" \"\"crm\"\" \"\"db-mgmt\"\" \"\"email\"\" \"\"enterprise\"\ + \" \"\"file-sharing\"\" \"\"file-system\"\" \"\"file-transfer\"\" \"\"\ + gaming\"\" \"\"intercomm\"\" \"\"logging\"\" \"\"management\"\" \"\"messaging\"\ + \" \"\"net-discovery\"\" \"\"net-mgmt\"\" \"\"net-monitor\"\" \"\"news-server\"\ + \" \"\"notification\"\" \"\"p2p\"\" \"\"printing\"\" \"\"proxy\"\" \"\"\ + recreational\"\" \"\"remote-desk\"\" \"\"remote-mgmt\"\" \"\"replication\"\ + \" \"\"routing\"\" \"\"saas\"\" \"\"secure-browsing\"\" \"\"storage\"\"\ + \ \"\"streaming\"\" \"\"tunnel\"\" \"\"utility\"\" \"\"voip\"\" \"\"wan-opt\"\ + \" \"\"web-browsing\"\" \"\"wireless-mgmt\"\" \"\"ip-protocol\"\" \"\"\ + multicast\"\" \"\"security\"\" \"\"i23v5\"\" \"\"printer\"\" \"\"default\"\ + \"\" \n" items: - description: Udp Filters - type: string + $ref: '#/components/schemas/UdpRuleV1' type: array - udp_port: - $ref: '#/components/schemas/Port' - description: "The start and end UDP port ranges. \n" - UdpRuleV2: + use_parentapp_network_policy: + description: 'If enabled, policy rule defined for the parent application + will be used to make routing decisions for this app. + + ' + type: boolean + AppdefOverrideScreenV2N2: 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) ' - items: - description: Dest Prefixes - type: string - type: array - dscp: - $ref: '#/components/schemas/DSCP' - description: 'The DSP value. + aggregate_flows: + description: 'The aggregate flows. ' - udp_filters: - description: 'The app def config IP list. Max size = 8. + type: boolean + app_unreachability_detection: + description: 'Application unreachability detection. ' - items: - description: Udp Filters + type: boolean + category: + description: 'The application category. + + ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default + type: string + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. + + ' + type: integer + description: + description: 'Description for the application. Max size = 256. + + ' + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. + + ' + items: + description: Domains type: string type: array - udp_port: - $ref: '#/components/schemas/Port' - description: "The start and end UDP port ranges. \n" -info: - contact: {} - description: List of APIs used to manage an application definition specific query, - overrides, and version information. - title: Applications - version: Latest -openapi: 3.0.0 -paths: - /sdwan/v2.0/api/appdefs_version: - get: - description: Get the application version for a tenant. - operationId: get-sdwan-v2.0-api-appdefs_version + id: + description: 'Application ID. + + ' + type: string + ingress_traffic_pct: + 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 + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. + + ' + items: + $ref: '#/components/schemas/IPRuleV2' + type: array + override_default_ip_rules: + description: 'The default override IP rules. + + ' + type: boolean + override_default_tcp_rules: + description: 'The default override TCP rules. + + ' + type: boolean + override_default_udp_rules: + description: 'The default override UDP rules. + + ' + type: boolean + override_domains: + description: 'List the override domains. + + ' + type: boolean + overrides_disable: + description: 'List the disabled overrides. + + ' + type: boolean + path_affinity: + description: "This parameter defines the path affinity characteristics to\ + \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ + \ \"strict\". If path affinity is none or weak and a better path is available,\ + \ flows will be moved to a new path. If path affinity is strict, all application\ + \ flows will continue on the same path. \n" + enum: + - none + - weak + - strict + type: string + session_timeout: + description: 'Application session timeout should be in between 0-44000. + + ' + type: integer + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. + + ' + items: + $ref: '#/components/schemas/TcpRuleV2' + type: array + transfer_type: + description: "Application transfer type. Allowed values: transactional,\ + \ bulk, rt-audio, rt-video. \n" + type: string + udp_rules: + description: 'For UDP applications, this dictionary will include information + on UDP port, DCSP settings, UDP Filters and destination prefixes. + + ' + items: + $ref: '#/components/schemas/UdpRuleV2' + type: array + use_parentapp_network_policy: + description: 'If enabled, policy rule defined for the parent application + will be used to make routing decisions for this app. + + ' + type: boolean + AppdefOverrideScreenV2N3: + properties: + aggregate_flows: + description: 'The aggregate flows. + + ' + type: boolean + app_unreachability_detection: + description: 'Application unreachability detection. + + ' + type: boolean + category: + description: 'The application category. + + ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default + type: string + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. + + ' + type: integer + description: + description: 'Description for the application. Max size = 256. + + ' + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. + + ' + items: + description: Domains + type: string + type: array + id: + description: 'Application ID. + + ' + type: string + ingress_traffic_pct: + 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 + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. + + ' + items: + $ref: '#/components/schemas/IPRuleV2' + type: array + override_default_ip_rules: + description: 'The default override IP rules. + + ' + type: boolean + override_default_tcp_rules: + description: 'The default override TCP rules. + + ' + type: boolean + override_default_udp_rules: + description: 'The default override UDP rules. + + ' + type: boolean + override_domains: + description: 'List the override domains. + + ' + type: boolean + overrides_disable: + description: 'List the disabled overrides. + + ' + type: boolean + p_category: + description: 'Parent App Category + + ' + enum: + - business-systems + - collaboration + - general-internet + - media + - networking + - saas + type: string + path_affinity: + description: "This parameter defines the path affinity characteristics to\ + \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ + \ \"strict\". If path affinity is none or weak and a better path is available,\ + \ flows will be moved to a new path. If path affinity is strict, all application\ + \ flows will continue on the same path. \n" + enum: + - none + - weak + - strict + type: string + session_timeout: + description: 'Application session timeout should be in between 0-44000. + + ' + type: integer + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. + + ' + items: + $ref: '#/components/schemas/TcpRuleV2' + type: array + transfer_type: + description: "Application transfer type. Allowed values: transactional,\ + \ bulk, rt-audio, rt-video. \n" + type: string + udp_rules: + description: 'For UDP applications, this dictionary will include information + on UDP port, DCSP settings, UDP Filters and destination prefixes. + + ' + items: + $ref: '#/components/schemas/UdpRuleV2' + type: array + use_parentapp_network_policy: + description: 'If enabled, policy rule defined for the parent application + will be used to make routing decisions for this app. + + ' + type: boolean + AppdefOverrideV2N1: + properties: + aggregate_flows: + description: Aggregate Flows + type: boolean + app_unreachability_detection: + description: App Unreachability Detection + type: boolean + category: + description: 'Category: ValidateEnum(enumClass = classOf[AppCategory], error + = APPDEF_CONFIG_INVALID_CATEGORY: Application category is invalid., nullAllowed + = true) ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default + type: string + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. + + ' + type: integer + description: + description: 'Description for the application. Max size = 256. + + ' + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. + + ' + items: + description: Domains + type: string + type: array + id: + description: 'Application ID. + + ' + 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) ' + type: integer + ip_rules: + description: 'Applicable for L3/L4 applications. These are IP Prefix rules + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. + + ' + items: + $ref: '#/components/schemas/IPRuleV1' + type: array + override_default_ip_rules: + description: 'List the override default IP rules. + + ' + type: boolean + override_default_tcp_rules: + description: 'List the override default TCP rules. + + ' + type: boolean + override_default_udp_rules: + description: 'List the override default UDP rules. + + ' + type: boolean + override_domains: + description: 'List the override domains. + + ' + type: boolean + overrides_disable: + description: 'List the disabled overrides. + + ' + type: boolean + path_affinity: + description: 'This parameter defines the path affinity characteristics to + consider during flow decision making. Allowed values: "none" "weak" "strict". + If path affinity is none or weak and a better path is available, flows + will be moved to a new path. If path affinity is strict, all application + flows will continue on the same path. + + ' + enum: + - none + - weak + - strict + type: string + session_timeout: + description: 'Application session timeout should be in between 0-44000. + + ' + type: integer + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. + + ' + items: + $ref: '#/components/schemas/TcpRuleV1' + type: array + transfer_type: + description: 'Application transfer type. Allowed values: transactional, + bulk, rt-audio, rt-video. + + ' + type: string + udp_rules: + description: "Application category. Allowed values: \"\"anonymity\"\" \"\ + \"anti-virus\"\" \"\"auth\"\" \"\"backup\"\" \"\"cad\"\" \"\"collaboration\"\ + \" \"\"conference\"\" \"\"crm\"\" \"\"db-mgmt\"\" \"\"email\"\" \"\"enterprise\"\ + \" \"\"file-sharing\"\" \"\"file-system\"\" \"\"file-transfer\"\" \"\"\ + gaming\"\" \"\"intercomm\"\" \"\"logging\"\" \"\"management\"\" \"\"messaging\"\ + \" \"\"net-discovery\"\" \"\"net-mgmt\"\" \"\"net-monitor\"\" \"\"news-server\"\ + \" \"\"notification\"\" \"\"p2p\"\" \"\"printing\"\" \"\"proxy\"\" \"\"\ + recreational\"\" \"\"remote-desk\"\" \"\"remote-mgmt\"\" \"\"replication\"\ + \" \"\"routing\"\" \"\"saas\"\" \"\"secure-browsing\"\" \"\"storage\"\"\ + \ \"\"streaming\"\" \"\"tunnel\"\" \"\"utility\"\" \"\"voip\"\" \"\"wan-opt\"\ + \" \"\"web-browsing\"\" \"\"wireless-mgmt\"\" \"\"ip-protocol\"\" \"\"\ + multicast\"\" \"\"security\"\" \"\"i23v5\"\" \"\"printer\"\" \"\"default\"\ + \"\" \n" + items: + $ref: '#/components/schemas/UdpRuleV1' + type: array + use_parentapp_network_policy: + description: 'If enabled, policy rule defined for the parent application + will be used to make routing decisions for this app. + + ' + type: boolean + AppdefOverrideV2N2: + properties: + aggregate_flows: + description: 'The aggregate flows. + + ' + type: boolean + app_unreachability_detection: + description: 'Application unreachability detection. + + ' + type: boolean + category: + description: 'The application category. + + ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default + type: string + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. + + ' + type: integer + description: + description: 'Description for the application. Max size = 256. + + ' + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. + + ' + items: + description: Domains + type: string + type: array + id: + description: 'Application ID. + + ' + type: string + ingress_traffic_pct: + 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 + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. + + ' + items: + $ref: '#/components/schemas/IPRuleV2' + type: array + override_default_ip_rules: + description: 'The default override IP rules. + + ' + type: boolean + override_default_tcp_rules: + description: 'The default override TCP rules. + + ' + type: boolean + override_default_udp_rules: + description: 'The default override UDP rules. + + ' + type: boolean + override_domains: + description: 'List the override domains. + + ' + type: boolean + overrides_disable: + description: 'List the disabled overrides. + + ' + type: boolean + path_affinity: + description: "This parameter defines the path affinity characteristics to\ + \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ + \ \"strict\". If path affinity is none or weak and a better path is available,\ + \ flows will be moved to a new path. If path affinity is strict, all application\ + \ flows will continue on the same path. \n" + enum: + - none + - weak + - strict + type: string + session_timeout: + description: 'Application session timeout should be in between 0-44000. + + ' + type: integer + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. + + ' + items: + $ref: '#/components/schemas/TcpRuleV2' + type: array + transfer_type: + description: "Application transfer type. Allowed values: transactional,\ + \ bulk, rt-audio, rt-video. \n" + type: string + udp_rules: + description: 'For UDP applications, this dictionary will include information + on UDP port, DCSP settings, UDP Filters and destination prefixes. + + ' + items: + $ref: '#/components/schemas/UdpRuleV2' + type: array + use_parentapp_network_policy: + description: 'If enabled, policy rule defined for the parent application + will be used to make routing decisions for this app. + + ' + type: boolean + AppdefOverrideV2N3: + properties: + aggregate_flows: + description: Aggregate Flows + type: boolean + app_unreachability_detection: + description: App Unreachability Detection + type: boolean + category: + description: 'The application category. + + ' + enum: + - anonymity + - anti-virus + - auth + - backup + - cad + - collaboration + - conference + - crm + - db-mgmt + - email + - enterprise + - file-sharing + - file-system + - file-transfer + - gaming + - intercomm + - logging + - management + - messaging + - net-discovery + - net-mgmt + - net-monitor + - news-server + - notification + - p2p + - printing + - proxy + - recreational + - remote-desk + - remote-mgmt + - replication + - routing + - saas + - secure-browsing + - storage + - streaming + - tunnel + - utility + - voip + - wan-opt + - web-browsing + - wireless-mgmt + - ip-protocol + - multicast + - security + - i23v5 + - printer + - default + type: string + conn_idle_timeout: + description: 'Connection Idle Timeout. Application connection timeout should + be in between 0-44000. + + ' + type: integer + description: + description: 'Description for the application. Max size = 256. + + ' + domains: + description: 'Applicable for layer 7 applications. List of application domains. + Maximum 16 valid domains are allowed and each domain should not exceed + 253 characters. + + ' + items: + description: Domains + type: string + type: array + id: + description: 'Application ID. + + ' + 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) ' + type: integer + ip_rules: + description: 'Applicable for L3/L4 applications. These are IP Prefix rules + used to identify the application viz protocol, dscp, source & destination + prefixes and source & destination prefixes. + + ' + items: + $ref: '#/components/schemas/IPRuleV2' + type: array + override_default_ip_rules: + description: 'The default override IP rules. + + ' + type: boolean + override_default_tcp_rules: + description: 'The default override TCP rules. + + ' + type: boolean + override_default_udp_rules: + description: 'The default override UDP rules. + + ' + type: boolean + override_domains: + description: 'List the override domains. + + ' + type: boolean + overrides_disable: + description: 'List the disabled overrides. + + ' + type: boolean + p_category: + description: 'Parent App Category + + ' + enum: + - business-systems + - collaboration + - general-internet + - media + - networking + - saas + type: string + path_affinity: + description: "This parameter defines the path affinity characteristics to\ + \ consider during flow decision making. Allowed values: \"none\" \"weak\"\ + \ \"strict\". If path affinity is none or weak and a better path is available,\ + \ flows will be moved to a new path. If path affinity is strict, all application\ + \ flows will continue on the same path. \n" + enum: + - none + - weak + - strict + type: string + session_timeout: + description: 'Application session timeout should be in between 0-44000. + + ' + type: integer + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + tcp_rules: + description: 'For TCP applications, this dictionary will include information + on client & server prefix filters, server & client ports, DCSP settings. + + ' + items: + $ref: '#/components/schemas/TcpRuleV2' + type: array + transfer_type: + description: "Application transfer type. Allowed values: transactional,\ + \ bulk, rt-audio, rt-video. \n" + type: string + udp_rules: + description: 'For UDP applications, this dictionary will include information + on UDP port, DCSP settings, UDP Filters and destination prefixes. + + ' + items: + $ref: '#/components/schemas/UdpRuleV2' + type: array + use_parentapp_network_policy: + description: 'If enabled, policy rule defined for the parent application + will be used to make routing decisions for this app. + + ' + type: boolean + BulkResponse: + properties: + count: + description: 'The total number. + + ' + format: int32 + type: integer + id: + description: 'The ID. + + ' + type: string + type: + description: "The type. \n" + type: string + DSCP: + properties: + value: + description: 'The DSCP value. + + ' + format: int32 + type: integer + Error: + properties: + _error: + items: + $ref: '#/components/schemas/ErrorResponse' + type: array + ErrorResponse: + properties: + code: + description: 'The error code. + + ' + type: string + message: + description: 'The error message. + + ' + type: string + Filter: + properties: + elements: + description: 'Elements of the filter. + + ' + items: + description: Elements + type: string + type: array + path: + description: 'Path of the filter. + + ' + items: + description: Path + type: string + type: array + site: + description: 'Site of the filter. + + ' + type: object + type: + description: 'Type of the filter. + + ' + type: string + required: + - path + - site + - elements + GlobalPrefixFilter: + properties: + description: + description: 'Description for the global prefix filter. + + ' + filters: + description: 'Filters: Required(PREFIXFILTER_REQUIRED) Valid ' + items: + $ref: '#/components/schemas/Filter' + type: array + id: + description: 'ID of the global prefix filter. + + ' + type: string + name: + description: 'Name of the global prefix filters. + + ' + type: string + required: + - filters + - name + GlobalPrefixFilterScreen: + properties: + description: + description: 'Description for the global prefix filter. + + ' + filters: + description: 'List the filters. + + ' + items: + $ref: '#/components/schemas/Filter' + type: array + id: + description: 'ID of the global prefix filter. + + ' + type: string + name: + description: 'Name of the global prefix filters. + + ' + type: string + required: + - filters + - name + GlobalPrefixQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of global prefixes that match the query + parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number global prefixes deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the global prefixs for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "Lists the global prefixes 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 + GlobalPrefixQueryFilter: + properties: + description: + description: 'The description of the security policy global prefix. Max + size = 256. + + ' + id: + description: 'The ID of the security policy global prefix. + + ' + type: string + ipv4_prefixes: + description: 'Lists the IPv4 addresses of the security policy global prefix. + + ' + items: + description: Ipv4 Prefixes + type: string + type: array + name: + description: 'The name of the security policy global prefix. Max size = + 128. + + ' + 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. + + ' + items: + description: Tags + type: string + type: array + required: + - name + IPRuleV1: + properties: + dest_filters: + description: 'Dest 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) ' + items: + description: Dest Filters + type: string + type: array + dscp: + $ref: '#/components/schemas/DSCP' + description: 'Dscp: Valid ' + protocol: + description: 'Protocol: ValidateEnum(enumClass = classOf[Protocol], error + = APPDEF_CONFIG_INVALID_PROTOCOL: Application protocol is invalid., nullAllowed + = false) ' + enum: + - ospf + - ipv6 + - is-is-over-ipv4 + - ipv6-nonxt + - etherip + - ipv6-icmp + - igmp + - udplite + - ipv6-opts + - icmp + - esp + - crtp + - ipip + - eigrp + - egp + - gre + - l2tpv3 + - sctp + - ip-in-ip + - rsvp + - pim + - scps + - mpls-in-ip + - ah + - vrrp + - ipv6-route + - igp + - ipv6-frag + type: string + src_filters: + description: 'Src 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) ' + items: + description: Src Filters + type: string + type: array + required: + - protocol + IPRuleV2: + properties: + dest_filters: + description: 'The app def destination filter list. Max size = 8. + + ' + items: + description: Dest Filters + 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) ' + items: + description: Dest Prefixes + type: string + type: array + dscp: + $ref: '#/components/schemas/DSCP' + description: 'The DSP value. + + ' + protocol: + description: 'The app def protocols. + + ' + enum: + - ospf + - ipv6 + - is-is-over-ipv4 + - ipv6-nonxt + - etherip + - ipv6-icmp + - igmp + - udplite + - ipv6-opts + - icmp + - esp + - crtp + - ipip + - eigrp + - egp + - gre + - l2tpv3 + - sctp + - ip-in-ip + - rsvp + - pim + - scps + - mpls-in-ip + - ah + - vrrp + - ipv6-route + - igp + - ipv6-frag + type: string + src_filters: + description: 'The app def src filters list. Max size = 8. + + ' + items: + description: Src Filters + type: string + type: array + required: + - protocol + 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 + LocalPrefixFilter: + properties: + description: + description: 'Description of the local prefix filter. + + ' + id: + description: 'Id of the local prefix filter. + + ' + type: string + name: + description: 'Name of the local prefix filter. + + ' + type: string + required: + - name + LocalPrefixFilterScreen: + properties: + description: + description: 'Description of the local prefix filter. + + ' + id: + description: 'ID of the local prefix filter. + + ' + type: string + name: + description: 'Name of the local prefix filter. + + ' + type: string + required: + - name + LocalPrefixQuery: + 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 the app definitions for the query. + + ' + 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: 'List the next query. + + ' + 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 marked fields to query. + + ' + type: boolean + sort_params: + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + Port: + properties: + end: + description: 'The end port range must be between 1 and 65535. + + ' + type: string + start: + description: 'The start port range must be between 1 and 65535. + + ' + type: string + TcpRule: + properties: + client_filters: + 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: 'The start and end client port ranges. + + ' + server_filters: + 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: 'The start and end server port ranges. + + ' + TcpRuleV1: + 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) ' + items: + description: Client Filters + type: string + type: array + client_port: + $ref: '#/components/schemas/Port' + description: 'Client Port: Valid ' + dscp: + $ref: '#/components/schemas/DSCP' + description: 'Dscp: Valid ' + 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) ' + items: + description: Server Filters + type: string + type: array + server_port: + $ref: '#/components/schemas/Port' + description: 'Server Port: Valid ' + TcpRuleV2: + properties: + client_filters: + 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: 'The start and end client port ranges. + + ' + dscp: + $ref: '#/components/schemas/DSCP' + description: 'The DSP value. + + ' + server_filters: + 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: '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: + 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) ' + items: + description: Server Prefixes + type: string + type: array + UdpRule: + properties: + udp_filters: + 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: "The start and end UDP port ranges. \n" + UdpRuleV1: + properties: + dscp: + $ref: '#/components/schemas/DSCP' + description: 'Dscp: Valid ' + 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) ' + items: + description: Udp Filters + type: string + type: array + udp_port: + $ref: '#/components/schemas/Port' + description: 'Udp Port: Valid ' + 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) ' + items: + description: Dest Prefixes + type: string + type: array + dscp: + $ref: '#/components/schemas/DSCP' + description: 'The DSP value. + + ' + udp_filters: + 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: "The start and end UDP port ranges. \n" +info: + contact: {} + description: List of APIs used to manage an application definition specific query, + overrides, and version information. + title: Applications + version: Latest +openapi: 3.0.0 +paths: + /sdwan/v2.0/api/appdefs: + get: + description: Lists the application definitions. + operationId: get-sdwan-v2.0-api-appdefs + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AppDefV2' + type: array + type: object + description: Successful Operation + summary: Get all Application Definitions (v2.0) + tags: + - Applications + post: + description: Create an application definition. + operationId: post-sdwan-v2.0-api-appdefs + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefScreenV2' + description: Application definition + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefV2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_INVALID_TYPE + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Application Definition (v2.0) + tags: + - Applications + /sdwan/v2.0/api/appdefs/query: + post: + description: Queries the DB for limit number of appdefs that match the query + parameters. + operationId: post-sdwan-v2.0-api-appdefs-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefQuery' + description: Query Details for the app def + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AppDefQueryFilterTransformed' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: GENERAL_CONFIG_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Number of AppDefs that Match Query Params (v2.0) + tags: + - Applications + /sdwan/v2.0/api/appdefs/{appdef_id}: + delete: + description: Delete a custom application definition. + operationId: delete-sdwan-v2.0-api-appdefs-appdef_id + parameters: + - description: The ID of the application definition. + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefV2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_APP_NOT_FOUND + - code: APPDEF_CONFIG_INVALID_APP + - code: APPDEF_CONFIG_APP_IN_USE + - code: APPLICATION_IS_USED_IN_IPFIX_PROFILE + - code: APPLICATION_IS_USED_IN_IPFIX_CONFIG + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Custom Application Definition (v2.0) + tags: + - Applications + get: + description: Get the application definition. + operationId: get-sdwan-v2.0-api-appdefs-appdef_id + parameters: + - description: Get the ID of the application definition. + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefV2' + description: Successful Operation + summary: Get Application Definition (v2.0) + tags: + - Applications + put: + description: Change the standard app version. + operationId: put-sdwan-v2.0-api-appdefs-appdef_id + parameters: + - description: The ID of the application definition. + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefTenantVersion' + description: Details of the app def tenant version to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefTenantVersion' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: GENERAL_CONFIG_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Change Standard Apps Version (v2.0) + tags: + - Applications + /sdwan/v2.0/api/appdefs/{appdef_id}/overrides: + get: + description: Get application definition overrides for system appdef. + operationId: get-sdwan-v2.0-api-appdefs-appdef_id-overrides + parameters: + - description: Get the ID of the application definition. + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverride' + description: Successful Operation + summary: Get Application Definition Overrides for System Appdef (v2.0) + tags: + - Applications + post: + description: Create an application definition overrides for system appdef. + operationId: post-sdwan-v2.0-api-appdefs-appdef_id-overrides + parameters: + - description: Get the ID of the application definition. + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverrideScreen' + description: Application definition Override + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverride' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_INVALID_SYSTEM_APPS + - code: APPDEF_CONFIG_APP_NOT_EXISTS + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_DEPRECATED_APP + - code: APPDEF_CONFIG_INVALID_OVERRIDE_DOMAIN_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_TCP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_UDP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_IP_FLAG + - code: APPDEF_CONFIG_NOT_ALLOWED + - code: APPDEF_CONFIG_MISSING_UDP_PORTS + - code: APPDEF_CONFIG_MISSING_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_UDP_PORTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Application Definition Overrides for System Appdef (v2.0) + tags: + - Applications + /sdwan/v2.0/api/appdefs/{appdef_id}/overrides/{override_id}: + delete: + description: Delete application definition overrides for system appdef. + operationId: delete-sdwan-v2.0-api-appdefs-appdef_id-overrides-override_id + parameters: + - description: Get the ID of the application definition. + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + - description: Get the override ID of the application definition. + in: path + name: override_id + required: true + schema: + description: Override Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverride' + description: Successful Operation + summary: Delete Application Definition Overrides for System Appdef (v2.0) + tags: + - Applications + get: + description: Get application definition overrides for system appdef. + operationId: get-sdwan-v2.0-api-appdefs-appdef_id-overrides-override_id + parameters: + - description: Get the ID of the application definition. + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + - description: Get the override ID of the application definition. + in: path + name: override_id + required: true + schema: + description: Override Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverride' + description: Successful Operation + summary: Get Application Definition Overrides for System Appdef (v2.0) + tags: + - Applications + put: + description: Update an application definition overrides for system appdef. + operationId: put-sdwan-v2.0-api-appdefs-appdef_id-overrides-override_id + parameters: + - description: Get the ID of the application definition. + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + - description: Get the override ID of the application definition. + in: path + name: override_id + required: true + schema: + description: Override Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverrideScreen' + description: Application definition Override + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverride' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_APP_NOT_EXISTS + - code: APPDEF_CONFIG_INVALID_APPDEF_ID + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_DEPRECATED_APP + - code: APPDEF_CONFIG_INVALID_OVERRIDE_DOMAIN_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_TCP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_UDP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_IP_FLAG + - code: APPDEF_CONFIG_NOT_ALLOWED + - code: APPDEF_CONFIG_MISSING_UDP_PORTS + - code: APPDEF_CONFIG_MISSING_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_UDP_PORTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Application Definition Overrides for System Appdef (v2.0) + tags: + - Applications + /sdwan/v2.0/api/appdefs_version: + get: + description: Get the application version for a tenant. + operationId: get-sdwan-v2.0-api-appdefs_version + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefTenantVersion' + description: Successful Operation + summary: Get Application Version for a Tenant (v2.0) + tags: + - Applications + /sdwan/v2.0/api/appdefs_version/{vid}: + get: + description: Change the standard app version. + operationId: get-sdwan-v2.0-api-appdefs_version-vid + parameters: + - description: Version ID. + in: path + name: vid + required: true + schema: + description: Vid + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AppDefV2' + type: array + type: object + description: Successful Operation + summary: Change Standard Apps Version (v2.0) + tags: + - Applications + put: + description: Change the standard app version. + operationId: put-sdwan-v2.0-api-appdefs_version-vid + parameters: + - description: Version ID. + in: path + name: vid + required: true + schema: + description: Vid + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefTenantVersion' + description: Details of the app def tenant version to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefTenantVersion' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: GENERAL_CONFIG_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Change Standard Apps Version (v2.0) + tags: + - Applications + /sdwan/v2.0/api/globalprefixfilters: + get: + description: Get the global prefix filters. + operationId: get-sdwan-v2.0-api-globalprefixfilters + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalPrefixFilter' + description: Successful Operation + summary: Get Global Prefix Filters (v2.0) + tags: + - Applications + post: + description: Create a new global prefix filter. + operationId: post-sdwan-v2.0-api-globalprefixfilters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalPrefixFilterScreen' + description: Details of the prefix filter to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalPrefixFilterScreen' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SECURITY_FILTER_DUPLICATE_FILTER + - code: SECURITY_FILTER_NAME_REQUIRED + - code: SECURITY_FILTER_INVALID_NAME + - code: SECURITY_FILTER_INVALID_DESCRIPTION + - code: JSON_SCHEMA_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create New Global Prefix Filter (v2.0) + tags: + - Applications + /sdwan/v2.0/api/globalprefixfilters/query: + post: + description: Lists the query details for the list of parameters for GlobalPrefixFilter. + operationId: post-sdwan-v2.0-api-globalprefixfilters-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalPrefixQuery' + description: Query Details for GlobalPrefixFilter + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/GlobalPrefixQueryFilter' + 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 List of Params (v2.0) + tags: + - Applications + /sdwan/v2.0/api/globalprefixfilters/{filter_id}: + delete: + description: Delete a specific global prefix filter. + operationId: delete-sdwan-v2.0-api-globalprefixfilters-filter_id + parameters: + - description: The ID of the global prefix filter. + in: path + name: filter_id + required: true + schema: + description: Filter Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalPrefixFilter' + description: Successful Operation + summary: Delete Global Prefix Filter (v2.0) + tags: + - Applications + get: + description: Get a specific global prefix filter. + operationId: get-sdwan-v2.0-api-globalprefixfilters-filter_id + parameters: + - description: The ID of the global prefix filter. + in: path + name: filter_id + required: true + schema: + description: Filter Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalPrefixFilter' + description: Successful Operation + summary: Get Specific Global Prefix Filter (v2.0) + tags: + - Applications + put: + description: Update a new global prefix filter. + operationId: put-sdwan-v2.0-api-globalprefixfilters-filter_id + parameters: + - description: The ID of the new global prefix filter. + in: path + name: filter_id + required: true + schema: + description: Filter Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalPrefixFilterScreen' + description: Details to update the global prefix filter. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalPrefixFilterScreen' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SECURITY_FILTER_DUPLICATE_FILTER + - code: SECURITY_FILTER_NAME_REQUIRED + - code: SECURITY_FILTER_INVALID_NAME + - code: SECURITY_FILTER_INVALID_DESCRIPTION + - code: JSON_SCHEMA_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Global Prefix Filter (v2.0) + tags: + - Applications + /sdwan/v2.0/api/localprefixfilters: + get: + description: Get the local prefix filters. + operationId: get-sdwan-v2.0-api-localprefixfilters + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/LocalPrefixFilter' + type: array + type: object + description: Successful Operation + summary: Get Local Prefix Filters (v2.0) + tags: + - Applications + post: + description: Create a new local prefix filter. + operationId: post-sdwan-v2.0-api-localprefixfilters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LocalPrefixFilterScreen' + description: Details of the prefix filter to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LocalPrefixFilter' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SECURITY_FILTER_DUPLICATE_FILTER + - code: SECURITY_FILTER_NAME_REQUIRED + - code: SECURITY_FILTER_INVALID_NAME + - code: SECURITY_FILTER_INVALID_DESCRIPTION + - code: JSON_SCHEMA_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create New Local Prefix Filter (v2.0) + tags: + - Applications + /sdwan/v2.0/api/localprefixfilters/query: + post: + description: Lists the query details for the list of parameters for GlobalPrefixFilter. + operationId: post-sdwan-v2.0-api-localprefixfilters-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LocalPrefixQuery' + description: Query Details for Local Prefix Filter responses: '200': content: application/json: schema: - $ref: '#/components/schemas/AppDefTenantVersion' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/LocalPrefixFilter' + type: array + type: object description: Successful Operation - summary: Get Application Version for a Tenant (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for List of Params (v2.0) + tags: + - Applications + /sdwan/v2.0/api/localprefixfilters/{id}: + delete: + description: Delete a specific local prefix filter. + operationId: delete-sdwan-v2.0-api-localprefixfilters-id + parameters: + - description: The ID of the local prefix filter. + in: path + name: id + required: true + schema: + description: Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LocalPrefixFilter' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: PREFIXFILTER_NAME_REQUIRED + - code: PREFIXFILTER_INVALID_DESCRIPTION + - code: PREFIXFILTER_INVALID_NAME + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Local Prefix Filter (v2.0) tags: - Applications - /sdwan/v2.0/api/appdefs_version/{vid}: get: - description: Change the standard app version. - operationId: get-sdwan-v2.0-api-appdefs_version-vid + description: Get a specific global prefix filter. + operationId: get-sdwan-v2.0-api-localprefixfilters-id parameters: - - description: Version ID. + - description: The ID of the local prefix filter. in: path - name: vid + name: id required: true schema: - description: Vid + description: Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LocalPrefixFilter' + description: Successful Operation + summary: Get Specific Local Prefix Filter (v2.0) + tags: + - Applications + put: + description: Update a new local prefix filter. + operationId: put-sdwan-v2.0-api-localprefixfilters-id + parameters: + - description: The ID of the new local prefix filter. + in: path + name: id + required: true + schema: + description: Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LocalPrefixFilterScreen' + description: Details to update the local prefix filter. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LocalPrefixFilterScreen' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SECURITY_FILTER_DUPLICATE_FILTER + - code: SECURITY_FILTER_NAME_REQUIRED + - code: SECURITY_FILTER_INVALID_NAME + - code: SECURITY_FILTER_INVALID_DESCRIPTION + - code: JSON_SCHEMA_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Local Prefix Filter (v2.0) + tags: + - Applications + /sdwan/v2.1/api/appdefs: + get: + description: Lists the application definitions. + operationId: get-sdwan-v2.1-api-appdefs responses: '200': content: @@ -3081,36 +5535,79 @@ paths: - properties: items: items: - $ref: '#/components/schemas/AppDefV2' + $ref: '#/components/schemas/AppDefV2N1' type: array type: object description: Successful Operation - summary: Change Standard Apps Version (v2.0) + summary: Get all Application Definitions (v2.1) tags: - Applications - put: - description: Change the standard app version. - operationId: put-sdwan-v2.0-api-appdefs_version-vid - parameters: - - description: Version ID. - in: path - name: vid - required: true - schema: - description: Vid - type: string + post: + description: Create an application definition. + operationId: post-sdwan-v2.1-api-appdefs requestBody: content: application/json: schema: - $ref: '#/components/schemas/AppDefTenantVersion' - description: Details of the app def tenant version to be created + $ref: '#/components/schemas/AppDefScreenV2N1' + description: Application definition responses: '200': content: application/json: schema: - $ref: '#/components/schemas/AppDefTenantVersion' + $ref: '#/components/schemas/AppDefV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_UPDATING_READ_ONLY_FIELD + - code: APPDEF_CONFIG_INVALID_TYPE + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_ORDER_NUMBER + - code: APPDEF_CONFIG_INVALID_ORDER_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Application Definition (v2.1) + tags: + - Applications + /sdwan/v2.1/api/appdefs/query: + post: + description: Queries the DB for limit number of appdefs that match the query + parameters. + operationId: post-sdwan-v2.1-api-appdefs-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefQuery' + description: Query Details for the app def + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AppDefQueryFilterTransformed' + type: array + type: object description: Successful Operation '400': content: @@ -3122,38 +5619,88 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Change Standard Apps Version (v2.0) + summary: Query DB for Number of AppDefs that Match Query Params (v2.1) + tags: + - Applications + /sdwan/v2.1/api/appdefs/{appdef_id}: + delete: + description: Delete an application definition. + operationId: delete-sdwan-v2.1-api-appdefs-appdef_id + parameters: + - description: The ID of the application definition. + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_INVALID_APP + - code: APPDEF_CONFIG_APP_IN_USE + - code: APPLICATION_IS_USED_IN_IPFIX_PROFILE + - code: APPLICATION_IS_USED_IN_IPFIX_CONFIG + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Application Definition (v2.1) tags: - Applications - /sdwan/v2.0/api/globalprefixfilters: get: - description: Get the global prefix filters. - operationId: get-sdwan-v2.0-api-globalprefixfilters + description: Get the application definition. + operationId: get-sdwan-v2.1-api-appdefs-appdef_id + parameters: + - description: Get the ID of the application definition. + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/GlobalPrefixFilter' + $ref: '#/components/schemas/AppDefV2N1' description: Successful Operation - summary: Get Global Prefix Filters (v2.0) + summary: Get Application Definition (v2.1) tags: - Applications - post: - description: Create a new global prefix filter. - operationId: post-sdwan-v2.0-api-globalprefixfilters + put: + description: Update an application definition. + operationId: put-sdwan-v2.1-api-appdefs-appdef_id + parameters: + - description: The ID of the application definition. + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/GlobalPrefixFilterScreen' - description: Details of the prefix filter to be created + $ref: '#/components/schemas/AppDefScreenV2N1' + description: Application definition responses: '200': content: application/json: schema: - $ref: '#/components/schemas/GlobalPrefixFilterScreen' + $ref: '#/components/schemas/AppDefV2N1' description: Successful Operation '400': content: @@ -3161,40 +5708,73 @@ paths: example: value: _error: - - code: SECURITY_FILTER_DUPLICATE_FILTER - - code: SECURITY_FILTER_NAME_REQUIRED - - code: SECURITY_FILTER_INVALID_NAME - - code: SECURITY_FILTER_INVALID_DESCRIPTION - - code: JSON_SCHEMA_MISMATCH + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_UPDATING_READ_ONLY_FIELD + - code: APPDEF_CONFIG_INVALID_TYPE + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_ORDER_NUMBER + - code: APPDEF_CONFIG_INVALID_ORDER_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_UDP_PORTS + - code: APPDEF_CONFIG_DEPRECATED_APP schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create New Global Prefix Filter (v2.0) + summary: Update Application Definition (v2.1) + tags: + - Applications + /sdwan/v2.1/api/appdefs/{appdef_id}/overrides: + get: + description: Get the application definition overrides for system appdefs. + operationId: get-sdwan-v2.1-api-appdefs-appdef_id-overrides + parameters: + - description: Get the ID of the application definition. + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverrideV2N1' + description: Successful Operation + summary: Get Application Definition Overrides for System Appdef (v2.1) tags: - Applications - /sdwan/v2.0/api/globalprefixfilters/query: post: - description: Lists the query details for the list of parameters for GlobalPrefixFilter. - operationId: post-sdwan-v2.0-api-globalprefixfilters-query + description: Create an application definition overrides for system appdef. + operationId: post-sdwan-v2.1-api-appdefs-appdef_id-overrides + parameters: + - description: Get the ID of the application definition. + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/GlobalPrefixQuery' - description: Query Details for GlobalPrefixFilter + $ref: '#/components/schemas/AppdefOverrideScreenV2N1' + description: Application definition Override responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/GlobalPrefixQueryFilter' - type: array - type: object + $ref: '#/components/schemas/AppdefOverrideV2N1' description: Successful Operation '400': content: @@ -3202,79 +5782,122 @@ paths: example: value: _error: - - code: BAD_QUERY_REQUEST + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_INVALID_SYSTEM_APPS + - code: APPDEF_CONFIG_APP_NOT_EXISTS + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_DEPRECATED_APP + - code: APPDEF_CONFIG_INVALID_OVERRIDE_DOMAIN_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_TCP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_UDP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_IP_FLAG + - code: APPDEF_CONFIG_NOT_ALLOWED + - code: APPDEF_CONFIG_MISSING_UDP_PORTS + - code: APPDEF_CONFIG_MISSING_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_UDP_PORTS + - code: APPDEF_CONFIG_READ_ONLY_USE_PARENTAPP_NETWORK_POLICY + - code: APPDEF_CONFIG_READ_ONLY_APP_UNREACHABILITY_DETECTION schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for List of Params (v2.0) + summary: Create Application Definition Overrides for System Appdef (v2.1) tags: - Applications - /sdwan/v2.0/api/globalprefixfilters/{filter_id}: + /sdwan/v2.1/api/appdefs/{appdef_id}/overrides/{override_id}: delete: - description: Delete a specific global prefix filter. - operationId: delete-sdwan-v2.0-api-globalprefixfilters-filter_id + description: Delete the application definition overrides for system appdefs. + operationId: delete-sdwan-v2.1-api-appdefs-appdef_id-overrides-override_id parameters: - - description: The ID of the global prefix filter. + - description: The ID of the application definition. in: path - name: filter_id + name: appdef_id required: true schema: - description: Filter Id + description: Appdef Id + type: string + - description: The override ID. + in: path + name: override_id + required: true + schema: + description: Override Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/GlobalPrefixFilter' + $ref: '#/components/schemas/AppdefOverrideV2N1' description: Successful Operation - summary: Delete Global Prefix Filter (v2.0) + summary: Delete Application Definition Overrides for System Appdef (v2.1) tags: - Applications get: - description: Get a specific global prefix filter. - operationId: get-sdwan-v2.0-api-globalprefixfilters-filter_id + description: Get the application definition overrides for system appdefs. + operationId: get-sdwan-v2.1-api-appdefs-appdef_id-overrides-override_id parameters: - - description: The ID of the global prefix filter. + - description: The ID of the application definition. in: path - name: filter_id + name: appdef_id required: true schema: - description: Filter Id + description: Appdef Id + type: string + - description: The override ID. + in: path + name: override_id + required: true + schema: + description: Override Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/GlobalPrefixFilter' + $ref: '#/components/schemas/AppdefOverrideV2N1' description: Successful Operation - summary: Get Specific Global Prefix Filter (v2.0) + summary: Get Application Definition Overrides for System Appdef (v2.1) tags: - Applications put: - description: Update a new global prefix filter. - operationId: put-sdwan-v2.0-api-globalprefixfilters-filter_id + description: Update the application definition overrides for system appdefs. + operationId: put-sdwan-v2.1-api-appdefs-appdef_id-overrides-override_id parameters: - - description: The ID of the new global prefix filter. + - description: The ID of the application definition. in: path - name: filter_id + name: appdef_id required: true schema: - description: Filter Id + description: Appdef Id + type: string + - description: The override ID. + in: path + name: override_id + required: true + schema: + description: Override Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/GlobalPrefixFilterScreen' - description: Details to update the global prefix filter. + $ref: '#/components/schemas/AppdefOverrideScreenV2N1' + description: Application definition Override responses: '200': content: application/json: schema: - $ref: '#/components/schemas/GlobalPrefixFilterScreen' + $ref: '#/components/schemas/AppdefOverrideV2N1' description: Successful Operation '400': content: @@ -3282,21 +5905,39 @@ paths: example: value: _error: - - code: SECURITY_FILTER_DUPLICATE_FILTER - - code: SECURITY_FILTER_NAME_REQUIRED - - code: SECURITY_FILTER_INVALID_NAME - - code: SECURITY_FILTER_INVALID_DESCRIPTION - - code: JSON_SCHEMA_MISMATCH + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_APP_NOT_EXISTS + - code: APPDEF_CONFIG_INVALID_APPDEF_ID + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_DEPRECATED_APP + - code: APPDEF_CONFIG_INVALID_OVERRIDE_DOMAIN_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_TCP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_UDP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_IP_FLAG + - code: APPDEF_CONFIG_NOT_ALLOWED + - code: APPDEF_CONFIG_MISSING_UDP_PORTS + - code: APPDEF_CONFIG_MISSING_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_UDP_PORTS + - code: APPDEF_CONFIG_READ_ONLY_USE_PARENTAPP_NETWORK_POLICY + - code: APPDEF_CONFIG_READ_ONLY_APP_UNREACHABILITY_DETECTION schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Global Prefix Filter (v2.0) + summary: Update Application Definition Overrides for System Appdef (v2.1) tags: - Applications - /sdwan/v2.0/api/localprefixfilters: + /sdwan/v2.2/api/appdefs: get: - description: Get the local prefix filters. - operationId: get-sdwan-v2.0-api-localprefixfilters + description: Lists all the application definitions. + operationId: get-sdwan-v2.2-api-appdefs responses: '200': content: @@ -3307,28 +5948,28 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LocalPrefixFilter' + $ref: '#/components/schemas/AppDefV2N2' type: array type: object description: Successful Operation - summary: Get Local Prefix Filters (v2.0) + summary: Get all Application Definitions (v2.2) tags: - Applications post: - description: Create a new local prefix filter. - operationId: post-sdwan-v2.0-api-localprefixfilters + description: Create an application definition. + operationId: post-sdwan-v2.2-api-appdefs requestBody: content: application/json: schema: - $ref: '#/components/schemas/LocalPrefixFilterScreen' - description: Details of the prefix filter to be created + $ref: '#/components/schemas/AppDefScreenV2N2' + description: Application definition responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LocalPrefixFilter' + $ref: '#/components/schemas/AppDefV2N2' description: Successful Operation '400': content: @@ -3336,27 +5977,39 @@ paths: example: value: _error: - - code: SECURITY_FILTER_DUPLICATE_FILTER - - code: SECURITY_FILTER_NAME_REQUIRED - - code: SECURITY_FILTER_INVALID_NAME - - code: SECURITY_FILTER_INVALID_DESCRIPTION - - code: JSON_SCHEMA_MISMATCH + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_UPDATING_READ_ONLY_FIELD + - code: APPDEF_CONFIG_INVALID_TYPE + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_ORDER_NUMBER + - code: APPDEF_CONFIG_INVALID_ORDER_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_APP_UNREACHABILITY_DETECTION + - code: APPDEF_CONFIG_INVALID_NWTWORK_SCAN_APPLICATION schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create New Local Prefix Filter (v2.0) + summary: Create Application Definition (v2.2) tags: - Applications - /sdwan/v2.0/api/localprefixfilters/query: + /sdwan/v2.2/api/appdefs/query: post: - description: Lists the query details for the list of parameters for GlobalPrefixFilter. - operationId: post-sdwan-v2.0-api-localprefixfilters-query + description: Queries the DB for limit number of appdefs that match the query + parameters. + operationId: post-sdwan-v2.2-api-appdefs-query requestBody: content: application/json: schema: - $ref: '#/components/schemas/LocalPrefixQuery' - description: Query Details for Local Prefix Filter + $ref: '#/components/schemas/AppDefQuery' + description: Query Details for the app def responses: '200': content: @@ -3367,7 +6020,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LocalPrefixFilter' + $ref: '#/components/schemas/AppDefQueryFilterTransformed' type: array type: object description: Successful Operation @@ -3377,31 +6030,31 @@ paths: example: value: _error: - - code: BAD_QUERY_REQUEST + - code: GENERAL_CONFIG_ERROR schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for List of Params (v2.0) + summary: Query DB for Number of AppDefs that Match Query Params (v2.2) tags: - Applications - /sdwan/v2.0/api/localprefixfilters/{id}: + /sdwan/v2.2/api/appdefs/{appdef_id}: delete: - description: Delete a specific local prefix filter. - operationId: delete-sdwan-v2.0-api-localprefixfilters-id + description: Delete an application definition. + operationId: delete-sdwan-v2.2-api-appdefs-appdef_id parameters: - - description: The ID of the local prefix filter. + - description: The ID of the application definition. in: path - name: id + name: appdef_id required: true schema: - description: Id + description: Appdef Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LocalPrefixFilter' + $ref: '#/components/schemas/AppDefV2N2' description: Successful Operation '400': content: @@ -3409,59 +6062,60 @@ paths: example: value: _error: - - code: PREFIXFILTER_NAME_REQUIRED - - code: PREFIXFILTER_INVALID_DESCRIPTION - - code: PREFIXFILTER_INVALID_NAME + - code: APPDEF_CONFIG_INVALID_APP + - code: APPDEF_CONFIG_APP_IN_USE + - code: APPLICATION_IS_USED_IN_IPFIX_PROFILE + - code: APPLICATION_IS_USED_IN_IPFIX_CONFIG schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Local Prefix Filter (v2.0) + summary: Delete Application Definition (v2.2) tags: - Applications get: - description: Get a specific global prefix filter. - operationId: get-sdwan-v2.0-api-localprefixfilters-id + description: Get the application definition. + operationId: get-sdwan-v2.2-api-appdefs-appdef_id parameters: - - description: The ID of the local prefix filter. + - description: Get the ID of the application definition. in: path - name: id + name: appdef_id required: true schema: - description: Id + description: Appdef Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LocalPrefixFilter' + $ref: '#/components/schemas/AppDefV2N2' description: Successful Operation - summary: Get Specific Local Prefix Filter (v2.0) + summary: Get Application Definition (v2.2) tags: - Applications put: - description: Update a new local prefix filter. - operationId: put-sdwan-v2.0-api-localprefixfilters-id + description: Update an application definition. + operationId: put-sdwan-v2.2-api-appdefs-appdef_id parameters: - - description: The ID of the new local prefix filter. + - description: The ID of the application definition. in: path - name: id + name: appdef_id required: true schema: - description: Id + description: Appdef Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/LocalPrefixFilterScreen' - description: Details to update the local prefix filter. + $ref: '#/components/schemas/AppDefScreenV2N2' + description: Application definition responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LocalPrefixFilterScreen' + $ref: '#/components/schemas/AppDefV2N2' description: Successful Operation '400': content: @@ -3469,15 +6123,28 @@ paths: example: value: _error: - - code: SECURITY_FILTER_DUPLICATE_FILTER - - code: SECURITY_FILTER_NAME_REQUIRED - - code: SECURITY_FILTER_INVALID_NAME - - code: SECURITY_FILTER_INVALID_DESCRIPTION - - code: JSON_SCHEMA_MISMATCH + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_UPDATING_READ_ONLY_FIELD + - code: APPDEF_CONFIG_INVALID_TYPE + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_ORDER_NUMBER + - code: APPDEF_CONFIG_INVALID_ORDER_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_UDP_PORTS + - code: APPDEF_CONFIG_DEPRECATED_APP + - code: APPDEF_CONFIG_INVALID_APP_UNREACHABILITY_DETECTION + - code: APPDEF_CONFIG_INVALID_NWTWORK_SCAN_APPLICATION schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Local Prefix Filter (v2.0) + summary: Update Application Definition (v2.2) tags: - Applications /sdwan/v2.2/api/appdefs/{appdef_id}/overrides: @@ -3576,24 +6243,256 @@ paths: type: string - description: Get the override ID of the application definition. in: path - name: override_id + name: override_id + required: true + schema: + description: Override Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverrideV2N2' + description: Successful Operation + summary: Delete Application Definition Overrides for System Appdef (v2.2) + tags: + - Applications + get: + description: Get the application definition overrides for system appdefs. + operationId: get-sdwan-v2.2-api-appdefs-appdef_id-overrides-override_id + parameters: + - description: Get the ID of the application definition. + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + - description: Get the override ID of the application definition. + in: path + name: override_id + required: true + schema: + description: Override Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverrideV2N2' + description: Successful Operation + summary: Get Application Definition Overrides for System Appdef (v2.2) + tags: + - Applications + put: + description: Update the application definition overrides for system appdefs. + operationId: put-sdwan-v2.2-api-appdefs-appdef_id-overrides-override_id + parameters: + - description: The ID of the application definition. + in: path + name: appdef_id + required: true + schema: + description: Appdef Id + type: string + - description: Get the override ID of the application definition. + in: path + name: override_id + required: true + schema: + description: Override Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverrideScreenV2N2' + description: Application definition Override + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppdefOverrideV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_APP_NOT_EXISTS + - code: APPDEF_CONFIG_INVALID_APPDEF_ID + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_DEPRECATED_APP + - code: APPDEF_CONFIG_INVALID_OVERRIDE_DOMAIN_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_TCP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_UDP_FLAG + - code: APPDEF_CONFIG_INVALID_OVERRIDE_IP_FLAG + - code: APPDEF_CONFIG_NOT_ALLOWED + - code: APPDEF_CONFIG_MISSING_UDP_PORTS + - code: APPDEF_CONFIG_MISSING_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_UDP_PORTS + - code: APPDEF_CONFIG_READ_ONLY_USE_PARENTAPP_NETWORK_POLICY + - code: APPDEF_CONFIG_READ_ONLY_APP_UNREACHABILITY_DETECTION + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Application Definition Overrides for System Appdef (v2.2) + tags: + - Applications + /sdwan/v2.3/api/appdefs: + get: + description: Lists all the application definitions. + operationId: get-sdwan-v2.3-api-appdefs + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AppDefV2N3' + type: array + type: object + description: Successful Operation + summary: Get all Application Definitions (v2.3) + tags: + - Applications + post: + description: Create an application definition. + operationId: post-sdwan-v2.3-api-appdefs + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefScreenV2N3' + description: Application definition + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_NO_SYSTEM_APPS + - code: APPDEF_CONFIG_UPDATING_READ_ONLY_FIELD + - code: APPDEF_CONFIG_INVALID_TYPE + - code: APPDEF_CONFIG_INVALID_PROTOCOL + - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT + - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_ORDER_NUMBER + - code: APPDEF_CONFIG_INVALID_ORDER_CONFIG + - code: APPDEF_CONFIG_INVALID_DSCP + - code: APPDEF_CONFIG_INVALID_TIMEOUT + - code: APPDEF_CONFIG_INVALID_INGRESS + - code: APPDEF_CONFIG_INVALID_PATHAFFINITY + - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE + - code: APPDEF_CONFIG_INVALID_TCP_PORTS + - code: APPDEF_CONFIG_INVALID_APP_UNREACHABILITY_DETECTION + - code: APPDEF_CONFIG_INVALID_NWTWORK_SCAN_APPLICATION + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Application Definition (v2.3) + tags: + - Applications + /sdwan/v2.3/api/appdefs/query: + post: + description: Queries the DB for limit number of appdefs that match the query + parameters. + operationId: post-sdwan-v2.3-api-appdefs-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppDefQuery' + description: Query Details for the app def + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AppDefQueryFilterTransformedV2N3' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: GENERAL_CONFIG_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Number of AppDefs that Match Query Params (v2.3) + tags: + - Applications + /sdwan/v2.3/api/appdefs/{appdef_id}: + delete: + description: Delete an application definition. + operationId: delete-sdwan-v2.3-api-appdefs-appdef_id + parameters: + - description: The ID of the application definition. + in: path + name: appdef_id required: true schema: - description: Override Id + description: Appdef Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/AppdefOverrideV2N2' + $ref: '#/components/schemas/AppDefV2N3' description: Successful Operation - summary: Delete Application Definition Overrides for System Appdef (v2.2) + '400': + content: + application/json: + example: + value: + _error: + - code: APPDEF_CONFIG_INVALID_APP + - code: APPDEF_CONFIG_APP_IN_USE + - code: APPLICATION_IS_USED_IN_IPFIX_PROFILE + - code: APPLICATION_IS_USED_IN_IPFIX_CONFIG + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Application Definition (v2.3) tags: - Applications get: - description: Get the application definition overrides for system appdefs. - operationId: get-sdwan-v2.2-api-appdefs-appdef_id-overrides-override_id + description: Get the application definition. + operationId: get-sdwan-v2.3-api-appdefs-appdef_id parameters: - description: Get the ID of the application definition. in: path @@ -3602,26 +6501,19 @@ paths: schema: description: Appdef Id type: string - - description: Get the override ID of the application definition. - in: path - name: override_id - required: true - schema: - description: Override Id - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/AppdefOverrideV2N2' + $ref: '#/components/schemas/AppDefV2N3' description: Successful Operation - summary: Get Application Definition Overrides for System Appdef (v2.2) + summary: Get Application Definition (v2.3) tags: - Applications put: - description: Update the application definition overrides for system appdefs. - operationId: put-sdwan-v2.2-api-appdefs-appdef_id-overrides-override_id + description: Update an application definition. + operationId: put-sdwan-v2.3-api-appdefs-appdef_id parameters: - description: The ID of the application definition. in: path @@ -3630,25 +6522,18 @@ paths: schema: description: Appdef Id type: string - - description: Get the override ID of the application definition. - in: path - name: override_id - required: true - schema: - description: Override Id - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/AppdefOverrideScreenV2N2' - description: Application definition Override + $ref: '#/components/schemas/AppDefScreenV2N3' + description: Application definition responses: '200': content: application/json: schema: - $ref: '#/components/schemas/AppdefOverrideV2N2' + $ref: '#/components/schemas/AppDefV2N3' description: Successful Operation '400': content: @@ -3657,32 +6542,27 @@ paths: value: _error: - code: APPDEF_CONFIG_NO_SYSTEM_APPS - - code: APPDEF_CONFIG_APP_NOT_EXISTS - - code: APPDEF_CONFIG_INVALID_APPDEF_ID + - code: APPDEF_CONFIG_UPDATING_READ_ONLY_FIELD + - code: APPDEF_CONFIG_INVALID_TYPE - code: APPDEF_CONFIG_INVALID_PROTOCOL - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT - code: APPDEF_CONFIG_INVALID_RULE_CONFIG + - code: APPDEF_CONFIG_INVALID_ORDER_NUMBER + - code: APPDEF_CONFIG_INVALID_ORDER_CONFIG - code: APPDEF_CONFIG_INVALID_DSCP - code: APPDEF_CONFIG_INVALID_TIMEOUT - code: APPDEF_CONFIG_INVALID_INGRESS - code: APPDEF_CONFIG_INVALID_PATHAFFINITY - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE - code: APPDEF_CONFIG_INVALID_TCP_PORTS - - code: APPDEF_CONFIG_DEPRECATED_APP - - code: APPDEF_CONFIG_INVALID_OVERRIDE_DOMAIN_FLAG - - code: APPDEF_CONFIG_INVALID_OVERRIDE_TCP_FLAG - - code: APPDEF_CONFIG_INVALID_OVERRIDE_UDP_FLAG - - code: APPDEF_CONFIG_INVALID_OVERRIDE_IP_FLAG - - code: APPDEF_CONFIG_NOT_ALLOWED - - code: APPDEF_CONFIG_MISSING_UDP_PORTS - - code: APPDEF_CONFIG_MISSING_TCP_PORTS - code: APPDEF_CONFIG_INVALID_UDP_PORTS - - code: APPDEF_CONFIG_READ_ONLY_USE_PARENTAPP_NETWORK_POLICY - - code: APPDEF_CONFIG_READ_ONLY_APP_UNREACHABILITY_DETECTION + - code: APPDEF_CONFIG_DEPRECATED_APP + - code: APPDEF_CONFIG_INVALID_APP_UNREACHABILITY_DETECTION + - code: APPDEF_CONFIG_INVALID_NWTWORK_SCAN_APPLICATION schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Application Definition Overrides for System Appdef (v2.2) + summary: Update Application Definition (v2.3) tags: - Applications /sdwan/v2.3/api/appdefs/{appdef_id}/overrides: @@ -4103,219 +6983,6 @@ paths: summary: Update Application Definition (v2.4) tags: - Applications - /sdwan/v2.5/api/appdefs: - get: - description: Lists all the application definitions. - operationId: get-sdwan-v2.5-api-appdefs - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/BulkResponse' - - properties: - items: - items: - $ref: '#/components/schemas/AppDefV2N5' - type: array - type: object - description: Successful Operation - summary: Get all Application Definitions (v2.5) - tags: - - Applications - post: - description: Create an application definition. - operationId: post-sdwan-v2.5-api-appdefs - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AppDefScreenV2N5' - description: Application definition - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AppDefV2N5' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: APPDEF_CONFIG_NO_SYSTEM_APPS - - code: APPDEF_CONFIG_UPDATING_READ_ONLY_FIELD - - code: APPDEF_CONFIG_INVALID_TYPE - - code: APPDEF_CONFIG_INVALID_PROTOCOL - - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT - - code: APPDEF_CONFIG_INVALID_RULE_CONFIG - - code: APPDEF_CONFIG_INVALID_ORDER_NUMBER - - code: APPDEF_CONFIG_INVALID_ORDER_CONFIG - - code: APPDEF_CONFIG_INVALID_DSCP - - code: APPDEF_CONFIG_INVALID_TIMEOUT - - code: APPDEF_CONFIG_INVALID_INGRESS - - code: APPDEF_CONFIG_INVALID_PATHAFFINITY - - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE - - code: APPDEF_CONFIG_INVALID_TCP_PORTS - - code: APPDEF_CONFIG_INVALID_APP_UNREACHABILITY_DETECTION - - code: APPDEF_CONFIG_INVALID_NWTWORK_SCAN_APPLICATION - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Application Definition (v2.5) - tags: - - Applications - /sdwan/v2.5/api/appdefs/query: - post: - description: Queries the DB for limit number of appdefs that match the query - parameters. - operationId: post-sdwan-v2.5-api-appdefs-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AppDefQuery' - description: Query Details for the app def - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/AppDefQueryFilterTransformedV2N4' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: GENERAL_CONFIG_ERROR - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query DB for Number of AppDefs that Match Query Params (v2.5) - tags: - - Applications - /sdwan/v2.5/api/appdefs/{appdef_id}: - delete: - description: Delete an application definition. - operationId: delete-sdwan-v2.5-api-appdefs-appdef_id - parameters: - - description: The ID of the application definition. - in: path - name: appdef_id - required: true - schema: - description: Appdef Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AppDefV2N5' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: APPDEF_CONFIG_INVALID_APP - - code: APPDEF_CONFIG_APP_IN_USE - - code: APPLICATION_IS_USED_IN_IPFIX_PROFILE - - code: APPLICATION_IS_USED_IN_IPFIX_CONFIG - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Application Definition (v2.5) - tags: - - Applications - get: - description: Get the application definition. - operationId: get-sdwan-v2.5-api-appdefs-appdef_id - parameters: - - description: Get the ID of the application definition. - in: path - name: appdef_id - required: true - schema: - description: Appdef Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AppDefV2N5' - description: Successful Operation - summary: Get Application Definition (v2.5) - tags: - - Applications - put: - description: Update an application definition. - operationId: put-sdwan-v2.5-api-appdefs-appdef_id - parameters: - - description: The ID of the application definition. - in: path - name: appdef_id - required: true - schema: - description: Appdef Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AppDefScreenV2N5' - description: Application definition - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AppDefV2N5' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: APPDEF_CONFIG_NO_SYSTEM_APPS - - code: APPDEF_CONFIG_UPDATING_READ_ONLY_FIELD - - code: APPDEF_CONFIG_INVALID_TYPE - - code: APPDEF_CONFIG_INVALID_PROTOCOL - - code: APPDEF_CONFIG_INVALID_SESSION_TIMEOUT - - code: APPDEF_CONFIG_INVALID_RULE_CONFIG - - code: APPDEF_CONFIG_INVALID_ORDER_NUMBER - - code: APPDEF_CONFIG_INVALID_ORDER_CONFIG - - code: APPDEF_CONFIG_INVALID_DSCP - - code: APPDEF_CONFIG_INVALID_TIMEOUT - - code: APPDEF_CONFIG_INVALID_INGRESS - - code: APPDEF_CONFIG_INVALID_PATHAFFINITY - - code: APPDEF_CONFIG_INVALID_TRANSFER_TYPE - - code: APPDEF_CONFIG_INVALID_TCP_PORTS - - code: APPDEF_CONFIG_INVALID_UDP_PORTS - - code: APPDEF_CONFIG_DEPRECATED_APP - - code: APPDEF_CONFIG_INVALID_APP_UNREACHABILITY_DETECTION - - code: APPDEF_CONFIG_INVALID_NWTWORK_SCAN_APPLICATION - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Application Definition (v2.5) - tags: - - Applications servers: - url: https://api.sase.paloaltonetworks.com tags: diff --git a/openapi-specs/sdwan/unified/Auditlogs.yaml b/openapi-specs/sdwan/unified/Auditlogs.yaml index 3064122a8..642e65045 100644 --- a/openapi-specs/sdwan/unified/Auditlogs.yaml +++ b/openapi-specs/sdwan/unified/Auditlogs.yaml @@ -2,21 +2,9 @@ components: schemas: Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -30,28 +18,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 AuditLog: properties: esp_tenant_id: diff --git a/openapi-specs/sdwan/unified/BulkOperations.yaml b/openapi-specs/sdwan/unified/BulkOperations.yaml index 8b60f6a64..86ce0a9f3 100644 --- a/openapi-specs/sdwan/unified/BulkOperations.yaml +++ b/openapi-specs/sdwan/unified/BulkOperations.yaml @@ -2,21 +2,9 @@ components: schemas: Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -30,28 +18,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 BaseQuery: properties: aggregate: diff --git a/openapi-specs/sdwan/unified/Cellular.yaml b/openapi-specs/sdwan/unified/Cellular.yaml index 913ffe67e..926844db3 100644 --- a/openapi-specs/sdwan/unified/Cellular.yaml +++ b/openapi-specs/sdwan/unified/Cellular.yaml @@ -251,21 +251,9 @@ components: - name Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -279,28 +267,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 BulkResponse: properties: count: diff --git a/openapi-specs/sdwan/unified/CloudBlades.yaml b/openapi-specs/sdwan/unified/CloudBlades.yaml index 66d79ee7b..dcc4ea4f5 100644 --- a/openapi-specs/sdwan/unified/CloudBlades.yaml +++ b/openapi-specs/sdwan/unified/CloudBlades.yaml @@ -63,6 +63,76 @@ components: ' type: string type: object + Parameter: + properties: + default_value: + description: 'The default value. + + ' + type: object + display_label: + description: 'The display label of the SD-WAN app. + + ' + type: string + help_text: + description: 'The help text in the app. + + ' + type: string + key: + description: 'The SD-WAN app config key. + + ' + type: string + max_length: + description: 'The max length of the SD-WAN app parameters. + + ' + type: integer + max_value: + description: 'The max value of the SD-WAN app parameters. + + ' + type: object + min_value: + description: 'The min value of the SD-WAN app parameters. + + ' + type: object + regex: + description: 'The regex values. + + ' + type: string + required: + description: 'The SD-WAN app required parameters. + + ' + type: boolean + sensitive: + description: 'The SD-WAN app sensitive parameters. + + ' + type: boolean + type: + description: 'The SD-WAN app parameters type. + + ' + enum: + - INTEGER + - FLOAT + - STRING + - TEXT + - EMAIL + - LIST_INTEGER + - LIST_FLOAT + - LIST_STRING + - LIST_INTEGER_MULTI_SELECT + - LIST_FLOAT_MULTI_SELECT + - LIST_STRING_MULTI_SELECT + - BOOLEAN + type: string ParameterListValueResponse: properties: display_label: @@ -420,6 +490,114 @@ components: - state - version - name + SDWANAppReleaseInfo: + properties: + default_release: + description: 'The default release of the app. + + ' + type: boolean + description: + description: 'The description of the SD-WAN app. Max length = 256. + + ' + name: + description: 'The name of the SD-WAN app. + + ' + type: string + parameters: + description: 'The app parameters. + + ' + items: + $ref: '#/components/schemas/Parameter' + type: array + permissions: + description: 'The permissions of the SD-WAN app. + + ' + items: + description: Permissions + type: string + type: array + release_date: + description: 'The release date of the SD-WAN app. + + ' + format: int64 + type: integer + release_notes: + description: 'The release notes of the SD-WAN app. + + ' + type: string + state: + description: 'The release state of the SD-WAN app. + + ' + enum: + - INIT + - ALPHA + - BETA + - GA + - DEPRECATED + - TO_BE_DELETED + type: string + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 unique tags of length 128 each are allowed. + + ' + items: + description: Tags + type: string + type: array + version: + description: 'The version of the SD-WAN app. + + ' + type: string + SDWANAppReleaseInfoResponse: + properties: + author: + $ref: '#/components/schemas/Author' + description: 'Details of the SD-WAN app owner. + + ' + description: + description: 'The description of the SD-WAN app. Max length = 256. + + ' + id: + description: 'The SD-WAN app ID. + + ' + type: string + name: + description: 'The name of the SD-WAN app. + + ' + type: string + releases: + description: 'The release information of the SD-WAN apps. + + ' + items: + $ref: '#/components/schemas/SDWANAppReleaseInfo' + type: array + tags: + description: 'A information field that can be added to identify the application. + Maximum 10 unique tags of length 128 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - author + - name SDWANAppReleaseInfoResponseV2N1: properties: author: @@ -682,6 +860,49 @@ info: version: Latest openapi: 3.0.0 paths: + /sdwan/v2.0/api/sdwanapps: + get: + description: GET existing tenant SD-WAN applications with release information. + operationId: get-sdwan-v2.0-api-sdwanapps + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SDWANAppReleaseInfoResponse' + type: array + type: object + description: Successful Operation + summary: GET existing tenant SD-WAN applications with release information. (v2.0) + tags: + - CloudBlades + /sdwan/v2.0/api/sdwanapps/{app_id}: + get: + description: GET existing tenant SD-WAN application with release information. + operationId: get-sdwan-v2.0-api-sdwanapps-app_id + parameters: + - description: SDWAN-APP tenant App ID + in: path + name: app_id + required: true + schema: + description: App Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SDWANAppReleaseInfoResponse' + description: Successful Operation + summary: GET existing tenant SD-WAN application with release information. (v2.0) + tags: + - CloudBlades /sdwan/v2.0/api/sdwanapps/{app_id}/configs: get: description: List all the SD-WAN application configurations. diff --git a/openapi-specs/sdwan/unified/DHCP.yaml b/openapi-specs/sdwan/unified/DHCP.yaml index 471c19e45..d363c56e6 100644 --- a/openapi-specs/sdwan/unified/DHCP.yaml +++ b/openapi-specs/sdwan/unified/DHCP.yaml @@ -1,5 +1,20 @@ components: schemas: + BaseCustomDHCPOptions: + properties: + option_definition: + description: 'Custom option definition. Max length supported is 1024. + + ' + type: string + option_value: + description: 'Custom option value. Max length supported is 8192. + + ' + type: string + required: + - option_value + - option_definition CustomDHCPOptions: properties: option_definition: @@ -18,16 +33,8 @@ components: required: - option_value - option_definition - DHCPServerScreenV2N2: + DHCPServer: properties: - address_family: - description: 'The DHCP config address values. - - ' - enum: - - IPV4 - - IPV6 - type: string broadcast_address: description: 'The address of the site. @@ -38,7 +45,7 @@ components: ' items: - $ref: '#/components/schemas/CustomDHCPOptions' + $ref: '#/components/schemas/BaseCustomDHCPOptions' type: array default_lease_time: description: 'The lease time each client will get if a user does not request @@ -102,7 +109,7 @@ components: ' items: - $ref: '#/components/schemas/StaticMappingV2' + $ref: '#/components/schemas/StaticMapping' type: array subnet: description: 'The subnet for which the DHCP server is being configured. @@ -119,19 +126,10 @@ components: type: string type: array required: - - address_family - ip_ranges - subnet - DHCPServerScreenV2N3: + DHCPServerScreen: properties: - address_family: - description: 'The DHCP config address values. - - ' - enum: - - IPV4 - - IPV6 - type: string broadcast_address: description: 'The address of the site. @@ -142,7 +140,7 @@ components: ' items: - $ref: '#/components/schemas/CustomDHCPOptions' + $ref: '#/components/schemas/BaseCustomDHCPOptions' type: array default_lease_time: description: 'The lease time each client will get if a user does not request @@ -206,7 +204,7 @@ components: ' items: - $ref: '#/components/schemas/StaticMappingV2' + $ref: '#/components/schemas/StaticMapping' type: array subnet: description: 'The subnet for which the DHCP server is being configured. @@ -222,25 +220,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 - subnet - DHCPServerV2N2: + DHCPServerScreenV2N1: properties: - address_family: - description: 'The DHCP config address values. - - ' - enum: - - IPV4 - - IPV6 - type: string broadcast_address: description: 'The address of the site. @@ -315,7 +299,7 @@ components: ' items: - $ref: '#/components/schemas/StaticMappingV2' + $ref: '#/components/schemas/StaticMapping' type: array subnet: description: 'The subnet for which the DHCP server is being configured. @@ -332,19 +316,10 @@ components: type: string type: array required: - - address_family - ip_ranges - subnet - DHCPServerV2N3: + DHCPServerV2N1: properties: - address_family: - description: 'The DHCP config address values. - - ' - enum: - - IPV4 - - IPV6 - type: string broadcast_address: description: 'The address of the site. @@ -419,7 +394,7 @@ components: ' items: - $ref: '#/components/schemas/StaticMappingV2' + $ref: '#/components/schemas/StaticMapping' type: array subnet: description: 'The subnet for which the DHCP server is being configured. @@ -435,13 +410,7 @@ 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 Error: @@ -489,11 +458,8 @@ components: ' type: string type: object - StaticMappingV2: + StaticMapping: 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. @@ -509,6 +475,7 @@ components: type: string required: - ip_address + - mac - name info: contact: {} @@ -517,10 +484,10 @@ info: version: Latest openapi: 3.0.0 paths: - /sdwan/v2.2/api/sites/{site_id}/dhcpservers: + /sdwan/v2.0/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.0-api-sites-site_id-dhcpservers parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -540,16 +507,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServer' 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.0) 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.0-api-sites-site_id-dhcpservers parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -563,14 +530,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerScreenV2N2' + $ref: '#/components/schemas/DHCPServerScreen' description: Details of dhcp server config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServer' description: Successful Operation '400': content: @@ -590,24 +557,16 @@ 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.2) + summary: Create DHCP Server Configuration for Subnet (v2.0) tags: - DHCP - /sdwan/v2.2/api/sites/{site_id}/dhcpservers/{dhcp_server_id}: + /sdwan/v2.0/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.0-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. @@ -629,14 +588,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServer' description: Successful Operation - summary: Delete DHCP Server for Tenant on Site (v2.2) + summary: Delete DHCP Server for Tenant on Site (v2.0) 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.0-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. @@ -658,14 +617,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServer' description: Successful Operation - summary: Get DHCP Server for Tenant on Site (v2.2) + summary: Get DHCP Server for Tenant on Site (v2.0) 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.0-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. @@ -686,14 +645,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerScreenV2N2' + $ref: '#/components/schemas/DHCPServerScreen' description: Details of dhcp server config to be Updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N2' + $ref: '#/components/schemas/DHCPServer' description: Successful Operation '400': content: @@ -713,24 +672,16 @@ 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.2) + summary: Update DHCP Server Configuration (v2.0) tags: - DHCP - /sdwan/v2.3/api/sites/{site_id}/dhcpservers: + /sdwan/v2.1/api/sites/{site_id}/dhcpservers: get: description: Get all the DHCP servers for a tenant on a site. - operationId: get-sdwan-v2.3-api-sites-site_id-dhcpservers + operationId: get-sdwan-v2.1-api-sites-site_id-dhcpservers parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -750,16 +701,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/DHCPServerV2N3' + $ref: '#/components/schemas/DHCPServerV2N1' type: array type: object description: Successful Operation - summary: Get DHCP Servers for Tenant on Site (v2.3) + summary: Get DHCP Servers for Tenant on Site (v2.1) tags: - DHCP post: description: Create a new DHCP server configuration for a subnet. - operationId: post-sdwan-v2.3-api-sites-site_id-dhcpservers + operationId: post-sdwan-v2.1-api-sites-site_id-dhcpservers parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -773,14 +724,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerScreenV2N3' + $ref: '#/components/schemas/DHCPServerScreenV2N1' description: Details of dhcp server config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N3' + $ref: '#/components/schemas/DHCPServerV2N1' description: Successful Operation '400': content: @@ -800,24 +751,16 @@ 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.3) + summary: Create DHCP Server Configuration for Subnet (v2.1) tags: - DHCP - /sdwan/v2.3/api/sites/{site_id}/dhcpservers/{dhcp_server_id}: + /sdwan/v2.1/api/sites/{site_id}/dhcpservers/{dhcp_server_id}: delete: description: Delete the DHCP Server for a tenant on a site. - operationId: delete-sdwan-v2.3-api-sites-site_id-dhcpservers-dhcp_server_id + operationId: delete-sdwan-v2.1-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. @@ -839,14 +782,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N3' + $ref: '#/components/schemas/DHCPServerV2N1' description: Successful Operation - summary: Delete DHCP Server for Tenant on Site (v2.3) + summary: Delete DHCP Server for Tenant on Site (v2.1) tags: - DHCP get: description: List the DHCP server for a tenant on a site. - operationId: get-sdwan-v2.3-api-sites-site_id-dhcpservers-dhcp_server_id + operationId: get-sdwan-v2.1-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. @@ -868,14 +811,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N3' + $ref: '#/components/schemas/DHCPServerV2N1' description: Successful Operation - summary: Get DHCP Server for Tenant on Site (v2.3) + summary: Get DHCP Server for Tenant on Site (v2.1) tags: - DHCP put: description: Update an existing DHCP server configuration for a subnet. - operationId: put-sdwan-v2.3-api-sites-site_id-dhcpservers-dhcp_server_id + operationId: put-sdwan-v2.1-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. @@ -896,14 +839,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DHCPServerScreenV2N3' + $ref: '#/components/schemas/DHCPServerScreenV2N1' description: Details of dhcp server config to be Updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DHCPServerV2N3' + $ref: '#/components/schemas/DHCPServerV2N1' description: Successful Operation '400': content: @@ -923,18 +866,10 @@ 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.3) + summary: Update DHCP Server Configuration (v2.1) tags: - DHCP servers: diff --git a/openapi-specs/sdwan/unified/DNSServices.yaml b/openapi-specs/sdwan/unified/DNSServices.yaml index f7409a6b4..a0d8d3c80 100644 --- a/openapi-specs/sdwan/unified/DNSServices.yaml +++ b/openapi-specs/sdwan/unified/DNSServices.yaml @@ -2,21 +2,9 @@ components: schemas: Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -30,28 +18,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 Alias: properties: mask: @@ -324,33 +290,6 @@ components: type: boolean required: - dns_servers - DnsForwardConfigV2: - properties: - dns_servers: - description: 'Details of the DNS severs. - - ' - items: - $ref: '#/components/schemas/DnsServersV2' - type: array - max_source_port: - description: 'The DNS service max source port. - - ' - type: integer - min_source_port: - description: 'The DNS service min source port. - - ' - format: int32 - type: integer - send_to_all_dns_servers: - description: 'If the option es enabled to send to all DNS servers. - - ' - type: boolean - required: - - dns_servers DnsQueriesMetadata: properties: add_client_mac: @@ -509,50 +448,6 @@ components: type: integer required: - dnsserver_ip - DnsServersV2: - properties: - address_family: - description: 'The DNS server address values. - - ' - enum: - - ipv4 - - ipv6 - - ipv4v6 - type: string - dnsserver_ip: - description: 'The DNS server IP address. - - ' - type: string - dnsserver_port: - description: 'The DNS server port. - - ' - type: integer - domain_names: - description: 'The DNS server domain names. - - ' - items: - description: Domain Names - type: string - type: array - forward_dnsservicerole_id: - description: 'The DNS forward service role ID. Max size = 20. - - ' - type: string - ip_prefix: - description: "The DNS server IP prefix. \n" - type: string - source_port: - description: 'The DNS server source port. - - ' - type: integer - required: - - dnsserver_ip DnsService: properties: cache_config: @@ -853,104 +748,6 @@ components: ' format: int64 type: integer - DnsServiceProfileV2N1: - properties: - authoritative_config: - $ref: '#/components/schemas/AuthoritativeConfig' - description: "The configuration details of the authoritative DNS server\ - \ where all the queries will try to resolve without forwarding it to external\ - \ servers. \n" - cache_config: - $ref: '#/components/schemas/CacheConfig' - description: 'Lists details of the cache configuration. - - ' - description: - description: 'The description of the DNS profiles. - - ' - dns_forward_config: - $ref: '#/components/schemas/DnsForwardConfigV2' - description: "Lists details of the DNS forward requests configuration. \ - \ \n" - dns_queries_metadata: - $ref: '#/components/schemas/DnsQueriesMetadata' - description: 'Lists the DNS queries parameters that append the client metadata - to the DNS query as it is sent to the upstream DNS server. - - ' - dns_rebind_config: - $ref: '#/components/schemas/DnsRebindConfig' - description: 'The details of the DNS rebind configuration. - - ' - dns_response_overrides: - $ref: '#/components/schemas/DnsResponseOverrides' - description: 'The details of the DNS response overrides. - - ' - dnssec_config: - $ref: '#/components/schemas/DnsSecConfig' - description: "The DNS secondary server configuration details. \ - \ \n" - domains_to_addresses: - description: 'The unique domain to address mapping and the IP address. - - ' - items: - $ref: '#/components/schemas/DomainsToAddress' - type: array - edns_packet_max: - description: 'The EDNS packets size. The default size is 4096. - - ' - format: int32 - type: integer - enable_dns_loop_detection: - description: 'If DNS loop detection is enabled. - - ' - type: boolean - enable_dnssec_proxy: - description: "If DNS second proxy is enabled. \n" - type: boolean - enable_strict_domain_name: - description: 'If DNS strict domain name is enabled. - - ' - type: boolean - id: - description: 'The ID. - - ' - type: string - listen_dnsservicerole_id: - description: "The ID mapped to the interfaces which are used for listening.\ - \ \n" - type: string - listen_port: - description: 'The port where the DNS is listening to the DNS queries. - - ' - format: int32 - type: integer - name: - description: 'The DNS profile name. - - ' - type: string - tags: - description: 'An information field that can be added to identify the DNS - profile. - - ' - items: - description: Tags - type: string - type: array - required: - - dns_forward_config - - name DnsServiceQuery: properties: aggregate: @@ -2388,351 +2185,6 @@ paths: summary: Update DNS Service Config (v2.0) tags: - DNS Services - /sdwan/v2.1/api/dnsserviceprofiles: - get: - description: Read all the DNS service profiles. - operationId: get-sdwan-v2.1-api-dnsserviceprofiles - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/DnsServiceProfileV2N1' - type: array - type: object - description: Successful Operation - summary: Read DNS Service Profiles (v2.1) - tags: - - DNS Services - post: - description: Create a new DNS service profile. - operationId: post-sdwan-v2.1-api-dnsserviceprofiles - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DnsServiceProfileV2N1' - description: Details of the DNS service profile to be created - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DnsServiceProfileV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: DNSSERVICE_PROFILE_CREATE_FAILED - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: INVALID_PROFILE_CONFIG - - code: INVALID_LISTENROLE_ID - - code: DNSSERVER_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: DNSSERVER_INVALID_FWDROLE_ID - - code: DNSREBIND_DOMAIN_CONFIG_INVALID_HOST - - code: DUPLICATE_DOMAINTOADDRESS_MAPPING_UNSUPPORTED - - code: DOMAINTOADDRESS_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: TRUST_ANCHORS_MISSING - - code: DISABLE_DNSSEC_TIMECHECK_NOT_ALLOWED - - code: DNS_CHECK_UNSIGNED_NOT_ALLOWED - - code: DNSSEC_CONFIG_NOT_ALLOWED - - code: HOSTRECORD_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: INVALID_NAPTRRECORD_CONFIG - - code: INVALID_SYNTH_DOMAIN_CONFIG - - code: INVALID_ALIAS_CONFIG - - code: INVALID_ADD_CUSTOMER_PREMISES_EQUIPMENT_CONFIG - - code: NAME_EXCEEDS_LIMIT - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_TAG - - code: INVALID_DNSSERVER_LISTEN_PORT_RANGE_CONFIG - - code: DNSSERVICE_CONFIG_INVALID_MINSOURCEPORT_VALUE - - code: DNSSERVICE_CONFIG_INVALID_MAXSOURCEPORT_VALUE - - code: INVALID_DNSSERVER_IP_PREFIX_CONFIG - - code: INVALID_DNSSERVER_DOMAIN_NAMES_LIST_CONFIG - - code: DNSSERVER_IP_CONFIG_MISSING - - code: INVALID_DNSSERVER_IP_CONFIG_IP - - code: INVALID_DNSSERVER_PORT_RANGE_CONFIG - - code: INVALID_DNSSERVER_SOURCE_PORT_RANGE_CONFIG - - code: INVALID_CUSTOMER_PREMISES_EQUIPMENT_TYPE - - code: DNSQUERYMETADATA_CONFIG_INVALID_IP_ADDRESS - - code: DNSQUERYMETADATA_CONFIG_INVALID_IP_PREFIX_LENGTH_RANGE - - code: DNSQUERYMETADATA_CONFIG_INVALID_IPV6_ADDRESS - - code: DNSQUERYMETADATA_CONFIG_INVALID_IPV6_PREFIX_LENGTH_RANGE - - code: INVALID_BOGUS_NX_DOMAINS - - code: INVALID_IGNORE_IP_ADDRESS - - code: ALIAS_CONFIG_INVALID_ORIGINAL_IP - - code: ALIAS_CONFIG_INVALID_ORIGINAL_START_IP - - code: ALIAS_CONFIG_INVALID_ORIGINAL_END_IP - - code: ALIAS_CONFIG_REPLACE_IP_ADDRESS_MISSING - - code: INVALID_DNSREBIND_REBIND_DOMAINS_LIST_CONFIG - - code: INVALID_TRUSTANCHOR_KEY_TAG_RANGE_CONFIG - - code: INVALID_TRUSTANCHOR_KEY_DIGEST_ALGO_RANGE_CONFIG - - code: INVALID_TRUSTANCHOR_KEY_DIGEST_TYPE_RANGE_CONFIG - - code: INVALID_DOMAINTOADDRESS_DOMAIN_NAMES_LIST_CONFIG - - code: DOMAINTOADDRESS_IP_CONFIG_MISSING - - code: INVALID_SECONDARY_SERVER - - code: INVALID_PEER_ADDRESS - - code: AUTHCONFIG_SERVER_DOMAIN_NAME_CONFIG_MISSING - - code: AUTHCONFIG_SERVER_DOMAIN_NAME_CONFIG_INVALID_HOST - - code: AUTHCONFIG_ZONE_DOMAIN_NAME_CONFIG_MISSING - - code: AUTHCONFIG_ZONE_DOMAIN_NAME_CONFIG_INVALID_HOST - - code: AUTHCONFIG_ZONE_INVALID_INCLUDE_PREFIX - - code: AUTHCONFIG_ZONE_INVALID_EXCLUDE_PREFIX - - code: AUTHCONFIG_SOA_SERIAL_NUMBER_CONFIG_MISSING - - code: INVALID_HOSTRECORD_DOMAIN_NAMES_LIST_CONFIG - - code: INVALID_HOSTRECORD_IPV4_CONFIG - - code: INVALID_HOSTRECORD_IPV6_CONFIG - - code: SYNTHDOMAIN_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: INVALID_SYNTHDOMAIN_START_IP_ADDRESS_CONFIG - - code: INVALID_SYNTHDOMAIN_END_IP_ADDRESS_CONFIG - - code: INVALID_SYNTHDOMAIN_IP_ADDRESS_PREFIX_CONFIG - - code: SRVHOST_SERVICE_MISSING - - code: SRVHOST_PROTOCOL_MISSING - - code: SRVHOST_DOMAIN_NAME_CONFIG_INVALID_HOST - - code: INVALID_SRVHOST_PORT_RANGE_CONFIG - - code: INVALID_SRVHOST_PRIORITY_RANGE_CONFIG - - code: NAPTRRECORD_NAME_MISSING - - code: INVALID_NAPTRRECORD_ORDER_RANGE_CONFIG - - code: NAPTRRECORD_ORDER_MISSING - - code: INVALID_NAPTRRECORD_PREFERENCE_RANGE_CONFIG - - code: NAPTRRECORD_PREFERENCE_MISSING - - code: NAPTRRECORD_FLAGS_MISSING - - code: CAARECORD_NAME_MISSING - - code: CAARECORD_FLAG_MISSING - - code: CAARECORD_TAG_MISSING - - code: CAARECORD_VALUE_MISSING - - code: DNSRESOURCERECORD_NAME_MISSING - - code: DNSRESOURCERECORD_RRNUMBER_MISSING - - code: CNAMERECORD_NAME_MISSING - - code: CNAMERECORD_TARGET_MISSING - - code: PTRRECORD_NAME_MISSING - - code: TXTRECORD_DOMAIN_NAME_MISSING - - code: TXTRECORD_TEXT_INVALID_LENGTH - - code: MX_NAME_MISSING - - code: MX_HOST_NAME_MISSING - - code: MX_NAME_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: INVALID_DNSSERVER_IP_CONFIG_IPV6 - - code: INVALID_DNSSERVER_IPV6_PREFIX_CONFIG - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create DNS Service Profile (v2.1) - tags: - - DNS Services - /sdwan/v2.1/api/dnsserviceprofiles/query: - post: - description: Query DNS service profiles based on parameters. - operationId: post-sdwan-v2.1-api-dnsserviceprofiles-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DnsServiceProfileQuery' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/DnsServiceProfileQuery' - type: array - type: object - description: Successful Operation - summary: Query DNS Service Profile (v2.1) - tags: - - DNS Services - /sdwan/v2.1/api/dnsserviceprofiles/{dnsservice_role_id}: - delete: - description: Delete an existing DNS service profile. - operationId: delete-sdwan-v2.1-api-dnsserviceprofiles-dnsservice_role_id - parameters: - - description: ID of the DNS service profile. - in: path - name: dnsservice_role_id - required: true - schema: - description: Dnsservice Role Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DnsServiceProfileV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: DNSPROFILE_CONFIG_DELETE_NOTALLOWED - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete DNS Service Profile (v2.1) - tags: - - DNS Services - get: - description: List a DNS service profile. - operationId: get-sdwan-v2.1-api-dnsserviceprofiles-dnsservice_role_id - parameters: - - description: ID of the DNS service profile. - in: path - name: dnsservice_role_id - required: true - schema: - description: Dnsservice Role Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DnsServiceProfileV2N1' - description: Successful Operation - summary: Get DNS Service Profile (v2.1) - tags: - - DNS Services - put: - description: Update a DNS service profile. - operationId: put-sdwan-v2.1-api-dnsserviceprofiles-dnsservice_role_id - parameters: - - description: ID of the DNS service profile. - in: path - name: dnsservice_role_id - required: true - schema: - description: Dnsservice Role Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DnsServiceProfileV2N1' - description: Details of the DNS service profile to be updated - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DnsServiceProfileV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: INVALID_PROFILE_CONFIG - - code: INVALID_LISTENROLE_ID - - code: DNSSERVER_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: DNSSERVER_INVALID_FWDROLE_ID - - code: DNSREBIND_DOMAIN_CONFIG_INVALID_HOST - - code: DUPLICATE_DOMAINTOADDRESS_MAPPING_UNSUPPORTED - - code: DOMAINTOADDRESS_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: TRUST_ANCHORS_MISSING - - code: DISABLE_DNSSEC_TIMECHECK_NOT_ALLOWED - - code: DNS_CHECK_UNSIGNED_NOT_ALLOWED - - code: DNSSEC_CONFIG_NOT_ALLOWED - - code: HOSTRECORD_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: INVALID_NAPTRRECORD_CONFIG - - code: INVALID_SYNTH_DOMAIN_CONFIG - - code: INVALID_ALIAS_CONFIG - - code: INVALID_ADD_CUSTOMER_PREMISES_EQUIPMENT_CONFIG - - code: NAME_EXCEEDS_LIMIT - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_TAG - - code: INVALID_DNSSERVER_LISTEN_PORT_RANGE_CONFIG - - code: DNSSERVICE_CONFIG_INVALID_MINSOURCEPORT_VALUE - - code: DNSSERVICE_CONFIG_INVALID_MAXSOURCEPORT_VALUE - - code: INVALID_DNSSERVER_IP_PREFIX_CONFIG - - code: INVALID_DNSSERVER_DOMAIN_NAMES_LIST_CONFIG - - code: DNSSERVER_IP_CONFIG_MISSING - - code: INVALID_DNSSERVER_IP_CONFIG_IP - - code: INVALID_DNSSERVER_PORT_RANGE_CONFIG - - code: INVALID_DNSSERVER_SOURCE_PORT_RANGE_CONFIG - - code: INVALID_CUSTOMER_PREMISES_EQUIPMENT_TYPE - - code: DNSQUERYMETADATA_CONFIG_INVALID_IP_ADDRESS - - code: DNSQUERYMETADATA_CONFIG_INVALID_IP_PREFIX_LENGTH_RANGE - - code: DNSQUERYMETADATA_CONFIG_INVALID_IPV6_ADDRESS - - code: DNSQUERYMETADATA_CONFIG_INVALID_IPV6_PREFIX_LENGTH_RANGE - - code: INVALID_BOGUS_NX_DOMAINS - - code: INVALID_IGNORE_IP_ADDRESS - - code: ALIAS_CONFIG_INVALID_ORIGINAL_IP - - code: ALIAS_CONFIG_INVALID_ORIGINAL_START_IP - - code: ALIAS_CONFIG_INVALID_ORIGINAL_END_IP - - code: ALIAS_CONFIG_REPLACE_IP_ADDRESS_MISSING - - code: INVALID_DNSREBIND_REBIND_DOMAINS_LIST_CONFIG - - code: INVALID_TRUSTANCHOR_KEY_TAG_RANGE_CONFIG - - code: INVALID_TRUSTANCHOR_KEY_DIGEST_ALGO_RANGE_CONFIG - - code: INVALID_TRUSTANCHOR_KEY_DIGEST_TYPE_RANGE_CONFIG - - code: INVALID_DOMAINTOADDRESS_DOMAIN_NAMES_LIST_CONFIG - - code: DOMAINTOADDRESS_IP_CONFIG_MISSING - - code: INVALID_SECONDARY_SERVER - - code: INVALID_PEER_ADDRESS - - code: AUTHCONFIG_SERVER_DOMAIN_NAME_CONFIG_MISSING - - code: AUTHCONFIG_SERVER_DOMAIN_NAME_CONFIG_INVALID_HOST - - code: AUTHCONFIG_ZONE_DOMAIN_NAME_CONFIG_MISSING - - code: AUTHCONFIG_ZONE_DOMAIN_NAME_CONFIG_INVALID_HOST - - code: AUTHCONFIG_ZONE_INVALID_INCLUDE_PREFIX - - code: AUTHCONFIG_ZONE_INVALID_EXCLUDE_PREFIX - - code: AUTHCONFIG_SOA_SERIAL_NUMBER_CONFIG_MISSING - - code: INVALID_HOSTRECORD_DOMAIN_NAMES_LIST_CONFIG - - code: INVALID_HOSTRECORD_IPV4_CONFIG - - code: INVALID_HOSTRECORD_IPV6_CONFIG - - code: SYNTHDOMAIN_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: INVALID_SYNTHDOMAIN_START_IP_ADDRESS_CONFIG - - code: INVALID_SYNTHDOMAIN_END_IP_ADDRESS_CONFIG - - code: INVALID_SYNTHDOMAIN_IP_ADDRESS_PREFIX_CONFIG - - code: SRVHOST_SERVICE_MISSING - - code: SRVHOST_PROTOCOL_MISSING - - code: SRVHOST_DOMAIN_NAME_CONFIG_INVALID_HOST - - code: INVALID_SRVHOST_PORT_RANGE_CONFIG - - code: INVALID_SRVHOST_PRIORITY_RANGE_CONFIG - - code: NAPTRRECORD_NAME_MISSING - - code: INVALID_NAPTRRECORD_ORDER_RANGE_CONFIG - - code: NAPTRRECORD_ORDER_MISSING - - code: INVALID_NAPTRRECORD_PREFERENCE_RANGE_CONFIG - - code: NAPTRRECORD_PREFERENCE_MISSING - - code: NAPTRRECORD_FLAGS_MISSING - - code: CAARECORD_NAME_MISSING - - code: CAARECORD_FLAG_MISSING - - code: CAARECORD_TAG_MISSING - - code: CAARECORD_VALUE_MISSING - - code: DNSRESOURCERECORD_NAME_MISSING - - code: DNSRESOURCERECORD_RRNUMBER_MISSING - - code: CNAMERECORD_NAME_MISSING - - code: CNAMERECORD_TARGET_MISSING - - code: PTRRECORD_NAME_MISSING - - code: TXTRECORD_DOMAIN_NAME_MISSING - - code: TXTRECORD_TEXT_INVALID_LENGTH - - code: MX_NAME_MISSING - - code: MX_HOST_NAME_MISSING - - code: MX_NAME_DOMAIN_NAMES_CONFIG_INVALID_HOST - - code: INVALID_DNSSERVER_IP_CONFIG_IPV6 - - code: INVALID_DNSSERVER_IPV6_PREFIX_CONFIG - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update DNS Service Profile (v2.1) - tags: - - DNS Services servers: - url: https://api.sase.paloaltonetworks.com tags: diff --git a/openapi-specs/sdwan/unified/DeviceConfiguration.yaml b/openapi-specs/sdwan/unified/DeviceConfiguration.yaml index 41c495ef9..f1bd1894f 100644 --- a/openapi-specs/sdwan/unified/DeviceConfiguration.yaml +++ b/openapi-specs/sdwan/unified/DeviceConfiguration.yaml @@ -53,21 +53,9 @@ components: type: string Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -81,28 +69,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 ApplicationProbe: properties: description: @@ -174,28 +140,60 @@ components: type: array required: - name - AuthenticationInterfaceConfig: + AuthenticationConfig: properties: - fallback_retry_count: - description: 'The fallback retry count. The fall back to MAC Auth if the - client is not using 802.1x authentication. - - ' - type: integer mode: - description: 'The auth mode. - - ' + description: 'Mode: ValidateEnum(enumClass = classOf[AuthenticationType], + error = INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_MAC_AUTH_TYPE: Invalid + interface configuration. Invalid dot1x type. Valid values are none, mac_auth + and dot1x., nullAllowed = false) ' enum: - none - dot1x - macauth - - dot1x-to-macauth-fallback type: string reauthentication_timeout: - description: 'Reauthentication timeout value. + description: 'Reauthentication Timeout: Range(max = 86400L, error = INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_REAUTH_TIMEOUT: + Invalid interface configuration. Invalid dot1x reauth timeout. Valid values + are 30 - 86400., min = 30L) ' + type: integer + required: + - mode + 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 BaseQuery: properties: @@ -300,6 +298,23 @@ components: wan_interface_id: description: 'The WAN interface ID. + ' + type: string + BypassPair: + properties: + lan: + description: 'Bypass port is connected to a LAN network. + + ' + type: string + use_relay: + description: 'The DHCP relay is selected to Yes. + + ' + type: boolean + wan: + description: 'Bypass port is connected to a WAN network. + ' type: string BypassPairV2: @@ -337,15 +352,6 @@ 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: @@ -610,177 +616,329 @@ components: type: string required: - site_id - ElementImageStatus: + ElementAggregateQueryFilterV2N5: properties: - active_image_id: - description: 'The active image ID. - - ' - type: string - failure_info: - description: 'The element image failure information. - - ' - type: string - id: - description: 'The ID. - - ' - type: string - previous_image_id: - description: 'The previous image ID. - - ' - type: string - upgrade_image_id: - description: 'The upgrade image ID. - - ' - type: string - upgrade_state: - description: 'The upgrade state of the element. - - ' + admin_action: + description: Admin Action enum: - - pending - - init - - discovery - - download - - download_init - - download_complete - - download_scheduled - - download_abort - - download_cancelled - - download_cancel_pending - - upgrade - - upgrade_init - - upgrade_complete - - upgrade_scheduled - - upgrade_abort - - upgrade_cancelled - - upgrade_cancel_pending - - upgrade_failed - - upgrading - - verify - - in-progress - - install - - complete - - done - - failed - - download_discovery - - download_failed - - downloading - - install_failed - - installing - - verifying - - waiting_download_time - - waiting_install_time - - abort_upgrade_pending - - abort_download_pending - - invalid + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID type: string - ElementImageStatusQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of element image status that match the - query parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number of element image status deleted for a time frame. - - ' - type: boolean - group_by: - description: 'Group the element image status for the query. - - ' - items: - description: Group By - type: string - type: array - id: - description: "List the element image status by ID. \n" + admin_renew_state: + description: Admin Renew State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION 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 + admin_suspend_state: + description: Admin Suspend State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION + type: string + aggregated_value: + description: Aggregated Value + format: int64 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. - - ' + allowed_roles: + description: Allowed Roles items: - description: Retrieved Fields + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string type: array - retrieved_fields_mask: - description: 'List the fields to query. - - ' + cluster_insertion_mode: + description: Cluster Insertion Mode + type: string + cluster_member_id: + description: Cluster Member Id + type: string + connected: + description: Connected 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. - - ' + 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 + fips_mode: + description: Fips Mode + enum: + - none + - fips + - non_fips + type: string + fips_mode_change_start_time: + description: Fips Mode Change Start Time format: int64 type: integer - ElementImageStatusQueryFilterV2N1: + hw_id: + description: Hw Id + type: string + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + model_name: + description: Model Name + type: string + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + 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.) ' + 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) ' + 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) ' + type: string + role: + description: Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + 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_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + 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 + 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) ' + items: + description: Tags + type: string + type: array + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding + type: boolean + required: + - site_id + ElementImageStatus: properties: active_image_id: description: 'The active image ID. ' type: string - active_version: - description: 'The active version. - - ' - type: string - download_interval: - description: 'The download interval. - - ' - type: integer - download_percent: - description: 'The download percentage. - - ' - type: integer - element_id: - description: Element Id - type: string failure_info: description: 'The element image failure information. @@ -794,21 +952,6 @@ components: previous_image_id: description: 'The previous image ID. - ' - type: string - rollback_version: - description: 'The rollback version. - - ' - type: string - scheduled_download: - description: 'The scheduled download. - - ' - type: string - scheduled_upgrade: - description: 'The scheduled upgrade. - ' type: string upgrade_image_id: @@ -816,11 +959,6 @@ components: ' type: string - upgrade_interval: - description: 'The upgrade interval. - - ' - type: integer upgrade_state: description: 'The upgrade state of the element. @@ -863,10 +1001,194 @@ components: - abort_download_pending - invalid type: string - ElementImageStatusV2N1: + ElementImageStatusQuery: properties: - active_image_id: - description: 'The active image ID. + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of element image status that match the + query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of element image status deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the element image status for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the element image status 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 + ElementImageStatusQueryFilterV2N1: + properties: + active_image_id: + description: 'The active image ID. + + ' + type: string + active_version: + description: 'The active version. + + ' + type: string + download_interval: + description: 'The download interval. + + ' + type: integer + download_percent: + description: 'The download percentage. + + ' + type: integer + element_id: + description: Element Id + type: string + failure_info: + description: 'The element image failure information. + + ' + type: string + id: + description: 'The ID. + + ' + type: string + previous_image_id: + description: 'The previous image ID. + + ' + type: string + rollback_version: + description: 'The rollback version. + + ' + type: string + scheduled_download: + description: 'The scheduled download. + + ' + type: string + scheduled_upgrade: + description: 'The scheduled upgrade. + + ' + type: string + upgrade_image_id: + description: 'The upgrade image ID. + + ' + type: string + upgrade_interval: + description: 'The upgrade interval. + + ' + type: integer + upgrade_state: + description: 'The upgrade state of the element. + + ' + enum: + - pending + - init + - discovery + - download + - download_init + - download_complete + - download_scheduled + - download_abort + - download_cancelled + - download_cancel_pending + - upgrade + - upgrade_init + - upgrade_complete + - upgrade_scheduled + - upgrade_abort + - upgrade_cancelled + - upgrade_cancel_pending + - upgrade_failed + - upgrading + - verify + - in-progress + - install + - complete + - done + - failed + - download_discovery + - download_failed + - downloading + - install_failed + - installing + - verifying + - waiting_download_time + - waiting_install_time + - abort_upgrade_pending + - abort_download_pending + - invalid + type: string + ElementImageStatusV2N1: + properties: + active_image_id: + description: 'The active image ID. ' type: string @@ -1035,12 +1357,10 @@ components: description: Total Count format: int64 type: integer - ElementQueryFilterV3: + ElementQueryFilter: properties: admin_action: - description: 'The values of admin actions that can be performed. - - ' + description: "The values of admin actions that can be performed. \n" enum: - ALLOCATE - CLAIM @@ -1056,177 +1376,34 @@ components: - DEFAULT - INVALID type: string - admin_renew_state: - description: 'The values of admin renew state. - - ' - enum: - - SLEEP - - INIT - - ACTIVE - - ACTIVE_ASSIGNED_DEFAULT - - ACTIVE_ASSIGNED_TENANT - - ACTIVE_TRUSTED - - ACTIVE_NOCERT - - ACTIVE_CLAIMED - - ACTIVE_MIC - - ACTIVE_MIC_PENDING - - ACTIVE_MIC_ISSUED - - ACTIVE_MIC_FAILED - - ACTIVE_CIC - - ACTIVE_CIC_SITE - - ACTIVE_CIC_PENDING - - ACTIVE_CIC_ISSUED - - ACTIVE_CIC_FAILED - - ACTIVE_INVENTORY_IN_PROGRESS - - ACTIVE_INVENTORY_GET_PENDING - - ACTIVE_INVENTORY_POST_PENDING - - ACTIVE_INVENTORY_GET_COMPLETE - - ACTIVE_INVENTORY_GET_FAILED - - ACTIVE_INVENTORY_OPERATION_FAILED - - ACTIVE_INTF_CONFIG_GET_PENDING - - ACTIVE_INTF_CONFIG_GET_COMPLETE - - ACTIVE_INTF_CONFIG_GET_FAILED - - ACTIVE_INTF_STATE_GET_PENDING - - ACTIVE_INTF_STATE_GET_COMPLETE - - ACTIVE_INTF_STATE_GET_FAILED - - ACTIVE_BOUND_TO_SITE_PENDING - - ACTIVE_BOUND_TO_SITE - - ACTIVE_BOUND_TO_SITE_FAILED - - ACTIVE_READY - - ACTIVE_RENEW_PENDING - - ACTIVE_RENEWED - - ACTIVE_DECLAIM_IN_PROGRESS - - ACTIVE_DECLAIMED - - ACTIVE_UNBOUND_FROM_SITE - - ACTIVE_UNBOUND_IN_PROGRESS - - ACTIVE_UNBOUND_FROM_SITE_FAILED - - ACTIVE_CIC_CERTIFICATE_CHECK - - ACTIVE_MONITORING - - ACTIVE_CONNECTED - - ACTIVE_24_HOURS_LESS - - ACTIVE_24_HOURS_MORE - - ACTIVE_TROUBLESHOOT - - ACTIVE_SUSPEND_INIT - - ACTIVE_SUSPEND_IN_PROGRESS - - ACTIVE_SUSPENDED - - ACTIVE_SUSPEND_FAILED - - ACTIVE_SUSPEND_FAILED_TIMEOUT - - ACTIVE_SUSPENDED_MIC_OPERATIONAL - - ACTIVE_SUSPENDED_CIC_OPERATIONAL - - ACTIVE_SUSPENDED_EMPTY_TOKEN - - ACTIVE_SUSPENDED_TOKEN_EXPIRED - - INACTIVE_NOCERT - - INACTIVE_MIC - - INACTIVE_CIC - - INACTIVE_CIC_SITE - - RETURNED - - STANDBY - - OOS_AT_READY - - OOS_AT_INIT - - OOS_AT_BIND_PENDING - - OOS_AT_BIND - - OOS_AT_BIND_FAILED - - OOS_AT_UNBIND_FAILED - - OOS_AT_UNBIND_PROGRESS - - DECOMMISSION - type: string - admin_suspend_state: - description: "The values of the admin suspend state. \n" - enum: - - SLEEP - - INIT - - ACTIVE - - ACTIVE_ASSIGNED_DEFAULT - - ACTIVE_ASSIGNED_TENANT - - ACTIVE_TRUSTED - - ACTIVE_NOCERT - - ACTIVE_CLAIMED - - ACTIVE_MIC - - ACTIVE_MIC_PENDING - - ACTIVE_MIC_ISSUED - - ACTIVE_MIC_FAILED - - ACTIVE_CIC - - ACTIVE_CIC_SITE - - ACTIVE_CIC_PENDING - - ACTIVE_CIC_ISSUED - - ACTIVE_CIC_FAILED - - ACTIVE_INVENTORY_IN_PROGRESS - - ACTIVE_INVENTORY_GET_PENDING - - ACTIVE_INVENTORY_POST_PENDING - - ACTIVE_INVENTORY_GET_COMPLETE - - ACTIVE_INVENTORY_GET_FAILED - - ACTIVE_INVENTORY_OPERATION_FAILED - - ACTIVE_INTF_CONFIG_GET_PENDING - - ACTIVE_INTF_CONFIG_GET_COMPLETE - - ACTIVE_INTF_CONFIG_GET_FAILED - - ACTIVE_INTF_STATE_GET_PENDING - - ACTIVE_INTF_STATE_GET_COMPLETE - - ACTIVE_INTF_STATE_GET_FAILED - - ACTIVE_BOUND_TO_SITE_PENDING - - ACTIVE_BOUND_TO_SITE - - ACTIVE_BOUND_TO_SITE_FAILED - - ACTIVE_READY - - ACTIVE_RENEW_PENDING - - ACTIVE_RENEWED - - ACTIVE_DECLAIM_IN_PROGRESS - - ACTIVE_DECLAIMED - - ACTIVE_UNBOUND_FROM_SITE - - ACTIVE_UNBOUND_IN_PROGRESS - - ACTIVE_UNBOUND_FROM_SITE_FAILED - - ACTIVE_CIC_CERTIFICATE_CHECK - - ACTIVE_MONITORING - - ACTIVE_CONNECTED - - ACTIVE_24_HOURS_LESS - - ACTIVE_24_HOURS_MORE - - ACTIVE_TROUBLESHOOT - - ACTIVE_SUSPEND_INIT - - ACTIVE_SUSPEND_IN_PROGRESS - - ACTIVE_SUSPENDED - - ACTIVE_SUSPEND_FAILED - - ACTIVE_SUSPEND_FAILED_TIMEOUT - - ACTIVE_SUSPENDED_MIC_OPERATIONAL - - ACTIVE_SUSPENDED_CIC_OPERATIONAL - - ACTIVE_SUSPENDED_EMPTY_TOKEN - - ACTIVE_SUSPENDED_TOKEN_EXPIRED - - INACTIVE_NOCERT - - INACTIVE_MIC - - INACTIVE_CIC - - INACTIVE_CIC_SITE - - RETURNED - - STANDBY - - OOS_AT_READY - - OOS_AT_INIT - - OOS_AT_BIND_PENDING - - OOS_AT_BIND - - OOS_AT_BIND_FAILED - - OOS_AT_UNBIND_FAILED - - OOS_AT_UNBIND_PROGRESS - - DECOMMISSION - 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_id: - description: Cluster Id - type: string - connected: - description: 'The element is connected. True or False. - - ' - type: boolean - deployment_op: - description: 'The deployment values. + 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: 'The cluster member ID. + + ' + type: string + connected: + description: 'The element is connected. True or False. + + ' + type: boolean + deployment_op: + description: 'The deployment values. ' enum: @@ -1248,29 +1425,16 @@ components: - GET_MAC_ADDRESS_TABLE type: string description: - description: 'The description of the element. - - ' - device_profile_id: - description: 'The device profile ID. - - ' - type: string - fips_mode: - description: 'The FIPs mode. + description: 'The description of the element. Max length = 256. ' - enum: - - none - - fips - - non_fips - type: string - fips_mode_change_start_time: - description: 'The FIPs mode change starting time. + events: + description: 'The details of the events occurred. ' - format: int64 - type: integer + items: + $ref: '#/components/schemas/BaseEventState' + type: array hw_id: description: 'The hardware ID. @@ -1279,59 +1443,11 @@ components: id: description: Id type: string - l3_direct_private_wan_forwarding: - description: 'The L3 direct private WAN is enabled. True or False. - - ' - type: boolean - 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: 'Valid LED config. - - ' - main_power_usage_threshold: - description: "The main power usage threshold. Allowed range is 50-100. \ - \ \n" - format: int32 - type: integer model_name: - description: "The model name of the device. \n" + description: "The model name of the device. \n" type: string name: - description: 'The name of the device. - - ' - type: string - 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. - - ' - type: string - override_indicator: - description: 'The override indicator. - - ' - items: - description: Override Indicator - type: string - type: array - priority_policysetstack_id: - description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack - API. + description: 'The name of the element. Max length = 128. ' type: string @@ -1340,12 +1456,12 @@ components: ' enum: - - NONE - - HUB - - SPOKE - - PA_WE_BR - PA_WE_DC + - PA_WE_BR + - NONE - PA_CONN + - SPOKE + - HUB type: string serial_number: description: 'The serial number. @@ -1362,11 +1478,16 @@ components: ' type: string - spoke_ha_config: - $ref: '#/components/schemas/SpokeHAConfigV2' - description: 'The details of the spoke HA configuration. + spoke_cluster_status: + description: 'The spoke cluster status. ' + enum: + - init + - active + - backup + - unknown + type: string state: description: 'The element state. @@ -1389,32 +1510,12 @@ components: - OOS - ACTIVE_DECLAIM_IN_PROGRESS type: string - switch_config: - $ref: '#/components/schemas/SwitchConfig' - description: 'The details of the switch configuration. - - ' - tags: - 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. True or False. - - ' - type: boolean required: - site_id - ElementQueryFilterV3N1: + ElementQueryFilterV2N1: properties: admin_action: - description: 'The values of admin actions that can be performed. - - ' + description: "The values of admin actions that can be performed. \n" enum: - ALLOCATE - CLAIM @@ -1430,154 +1531,6 @@ components: - DEFAULT - INVALID type: string - admin_renew_state: - description: 'The values of admin renew state. - - ' - enum: - - SLEEP - - INIT - - ACTIVE - - ACTIVE_ASSIGNED_DEFAULT - - ACTIVE_ASSIGNED_TENANT - - ACTIVE_TRUSTED - - ACTIVE_NOCERT - - ACTIVE_CLAIMED - - ACTIVE_MIC - - ACTIVE_MIC_PENDING - - ACTIVE_MIC_ISSUED - - ACTIVE_MIC_FAILED - - ACTIVE_CIC - - ACTIVE_CIC_SITE - - ACTIVE_CIC_PENDING - - ACTIVE_CIC_ISSUED - - ACTIVE_CIC_FAILED - - ACTIVE_INVENTORY_IN_PROGRESS - - ACTIVE_INVENTORY_GET_PENDING - - ACTIVE_INVENTORY_POST_PENDING - - ACTIVE_INVENTORY_GET_COMPLETE - - ACTIVE_INVENTORY_GET_FAILED - - ACTIVE_INVENTORY_OPERATION_FAILED - - ACTIVE_INTF_CONFIG_GET_PENDING - - ACTIVE_INTF_CONFIG_GET_COMPLETE - - ACTIVE_INTF_CONFIG_GET_FAILED - - ACTIVE_INTF_STATE_GET_PENDING - - ACTIVE_INTF_STATE_GET_COMPLETE - - ACTIVE_INTF_STATE_GET_FAILED - - ACTIVE_BOUND_TO_SITE_PENDING - - ACTIVE_BOUND_TO_SITE - - ACTIVE_BOUND_TO_SITE_FAILED - - ACTIVE_READY - - ACTIVE_RENEW_PENDING - - ACTIVE_RENEWED - - ACTIVE_DECLAIM_IN_PROGRESS - - ACTIVE_DECLAIMED - - ACTIVE_UNBOUND_FROM_SITE - - ACTIVE_UNBOUND_IN_PROGRESS - - ACTIVE_UNBOUND_FROM_SITE_FAILED - - ACTIVE_CIC_CERTIFICATE_CHECK - - ACTIVE_MONITORING - - ACTIVE_CONNECTED - - ACTIVE_24_HOURS_LESS - - ACTIVE_24_HOURS_MORE - - ACTIVE_TROUBLESHOOT - - ACTIVE_SUSPEND_INIT - - ACTIVE_SUSPEND_IN_PROGRESS - - ACTIVE_SUSPENDED - - ACTIVE_SUSPEND_FAILED - - ACTIVE_SUSPEND_FAILED_TIMEOUT - - ACTIVE_SUSPENDED_MIC_OPERATIONAL - - ACTIVE_SUSPENDED_CIC_OPERATIONAL - - ACTIVE_SUSPENDED_EMPTY_TOKEN - - ACTIVE_SUSPENDED_TOKEN_EXPIRED - - INACTIVE_NOCERT - - INACTIVE_MIC - - INACTIVE_CIC - - INACTIVE_CIC_SITE - - RETURNED - - STANDBY - - OOS_AT_READY - - OOS_AT_INIT - - OOS_AT_BIND_PENDING - - OOS_AT_BIND - - OOS_AT_BIND_FAILED - - OOS_AT_UNBIND_FAILED - - OOS_AT_UNBIND_PROGRESS - - DECOMMISSION - type: string - admin_suspend_state: - description: "The values of the admin suspend state. \n" - enum: - - SLEEP - - INIT - - ACTIVE - - ACTIVE_ASSIGNED_DEFAULT - - ACTIVE_ASSIGNED_TENANT - - ACTIVE_TRUSTED - - ACTIVE_NOCERT - - ACTIVE_CLAIMED - - ACTIVE_MIC - - ACTIVE_MIC_PENDING - - ACTIVE_MIC_ISSUED - - ACTIVE_MIC_FAILED - - ACTIVE_CIC - - ACTIVE_CIC_SITE - - ACTIVE_CIC_PENDING - - ACTIVE_CIC_ISSUED - - ACTIVE_CIC_FAILED - - ACTIVE_INVENTORY_IN_PROGRESS - - ACTIVE_INVENTORY_GET_PENDING - - ACTIVE_INVENTORY_POST_PENDING - - ACTIVE_INVENTORY_GET_COMPLETE - - ACTIVE_INVENTORY_GET_FAILED - - ACTIVE_INVENTORY_OPERATION_FAILED - - ACTIVE_INTF_CONFIG_GET_PENDING - - ACTIVE_INTF_CONFIG_GET_COMPLETE - - ACTIVE_INTF_CONFIG_GET_FAILED - - ACTIVE_INTF_STATE_GET_PENDING - - ACTIVE_INTF_STATE_GET_COMPLETE - - ACTIVE_INTF_STATE_GET_FAILED - - ACTIVE_BOUND_TO_SITE_PENDING - - ACTIVE_BOUND_TO_SITE - - ACTIVE_BOUND_TO_SITE_FAILED - - ACTIVE_READY - - ACTIVE_RENEW_PENDING - - ACTIVE_RENEWED - - ACTIVE_DECLAIM_IN_PROGRESS - - ACTIVE_DECLAIMED - - ACTIVE_UNBOUND_FROM_SITE - - ACTIVE_UNBOUND_IN_PROGRESS - - ACTIVE_UNBOUND_FROM_SITE_FAILED - - ACTIVE_CIC_CERTIFICATE_CHECK - - ACTIVE_MONITORING - - ACTIVE_CONNECTED - - ACTIVE_24_HOURS_LESS - - ACTIVE_24_HOURS_MORE - - ACTIVE_TROUBLESHOOT - - ACTIVE_SUSPEND_INIT - - ACTIVE_SUSPEND_IN_PROGRESS - - ACTIVE_SUSPENDED - - ACTIVE_SUSPEND_FAILED - - ACTIVE_SUSPEND_FAILED_TIMEOUT - - ACTIVE_SUSPENDED_MIC_OPERATIONAL - - ACTIVE_SUSPENDED_CIC_OPERATIONAL - - ACTIVE_SUSPENDED_EMPTY_TOKEN - - ACTIVE_SUSPENDED_TOKEN_EXPIRED - - INACTIVE_NOCERT - - INACTIVE_MIC - - INACTIVE_CIC - - INACTIVE_CIC_SITE - - RETURNED - - STANDBY - - OOS_AT_READY - - OOS_AT_INIT - - OOS_AT_BIND_PENDING - - OOS_AT_BIND - - OOS_AT_BIND_FAILED - - OOS_AT_UNBIND_FAILED - - OOS_AT_UNBIND_PROGRESS - - DECOMMISSION - type: string allowed_roles: description: "The allowed roles. \n" items: @@ -1591,11 +1544,16 @@ components: - PA_CONN type: string type: array - cluster_id: - description: Cluster Id + cluster_insertion_mode: + description: "The cluster insertion mode. \n" + type: string + cluster_member_id: + description: 'The cluster member ID. + + ' type: string connected: - description: 'The element is connected. True or False. + description: 'The device is connected. True or False. ' type: boolean @@ -1622,53 +1580,11 @@ components: - GET_MAC_ADDRESS_TABLE type: string description: - 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. - - ' - type: string - fips_mode: - description: 'The FIPs mode. - - ' - enum: - - none - - fips - - non_fips - type: string - fips_mode_change_start_time: - description: 'The FIPs mode change starting time. + description: 'The description of the element filter. ' - format: int64 - type: integer hw_id: - description: 'The hardware ID. - - ' + description: "The hardware ID. \n" type: string id: description: Id @@ -1685,49 +1601,23 @@ components: ' type: boolean - led_config: - $ref: '#/components/schemas/LedConfig' - description: 'Valid LED config. - - ' - main_power_usage_threshold: - description: "The main power usage threshold. Allowed range is 50-100. \ - \ \n" - format: int32 - type: integer model_name: description: "The model name of the device. \n" type: string name: description: 'The name of the device. - ' - type: string - 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: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - override_indicator: - description: 'The override indicator. - - ' - items: - description: Override Indicator - type: string - type: array priority_policysetstack_id: - description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack - API. - - ' + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string role: description: 'The element role. @@ -1756,11 +1646,6 @@ components: ' type: string - spoke_ha_config: - $ref: '#/components/schemas/SpokeHAConfigV2' - description: 'The details of the spoke HA configuration. - - ' state: description: 'The element state. @@ -1783,897 +1668,616 @@ components: - OOS - ACTIVE_DECLAIM_IN_PROGRESS type: string - switch_config: - $ref: '#/components/schemas/SwitchConfig' - description: 'The details of the switch configuration. - - ' - tags: - 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. True or False. - - ' - type: boolean required: - site_id - ElementScreenV3: + ElementQueryFilterV2N2: properties: - cluster_id: - description: "The cluster ID. \n" - type: string - description: - description: 'The description of the element. - - ' - device_profile_id: - description: "The device profile ID. \n" + admin_action: + description: Admin Action + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID type: string - id: - description: "The element ID. \n" - type: string - l3_direct_private_wan_forwarding: - description: 'The L3 direct private WAN is enabled. True or False. - - ' - type: boolean - 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: 'Valid LED config. - - ' - main_power_usage_threshold: - description: "The main power usage threshold. Allowed range is 50-100. \ - \ \n" - format: int32 - type: integer - name: - description: 'The name of the device. - - ' - type: string - 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. - - ' - type: string - priority_policysetstack_id: - description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack - API. - - ' - type: string - site_id: - description: "The site ID. \n" - type: string - spoke_ha_config: - $ref: '#/components/schemas/SpokeHAConfigV2' - description: 'The details of the spoke HA configuration. - - ' - sw_obj: - $ref: '#/components/schemas/Software' - description: 'The location and version of the software. - - ' - switch_config: - $ref: '#/components/schemas/SwitchConfig' - description: 'The details of the switch configuration. - - ' - tags: - description: 'A information field that can be added to identify the element. - - ' + allowed_roles: + description: Allowed Roles items: - description: Tags + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string type: array - vpn_to_vpn_forwarding: - description: 'VPN to VPN forwarding. True or False. - - ' + cluster_insertion_mode: + description: Cluster Insertion Mode + type: string + cluster_member_id: + description: Cluster Member Id + type: string + connected: + description: Connected type: boolean - required: - - site_id - ElementScreenV3N1: - properties: - cluster_id: - description: "The cluster ID. \n" + 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: 'The description of the element. - - ' - device_profile_id: - description: "The device profile ID. \n" + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + hw_id: + description: Hw Id type: string id: - description: "The element ID. \n" + description: Id type: string l3_direct_private_wan_forwarding: - description: 'The L3 direct private WAN is enabled. True or False. - - ' + description: L3 Direct Private Wan Forwarding type: boolean 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. - - ' + description: L3 Lan Forwarding type: boolean - led_config: - $ref: '#/components/schemas/LedConfig' - description: 'Valid LED config. - - ' - main_power_usage_threshold: - description: "The main power usage threshold. Allowed range is 50-100. \ - \ \n" - format: int32 - type: integer - name: - description: 'The name of the device. - - ' + model_name: + description: Model Name type: string - nat_policysetstack_id: - description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack - API. - - ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string network_policysetstack_id: - description: 'The ID for the Path Policyset Stack. Can be retrieved using - networkpolicysetstack API. - - ' + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string priority_policysetstack_id: - description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack - API. - - ' + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' + type: string + role: + description: Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + serial_number: + description: Serial Number type: string site_id: - description: "The site ID. \n" + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + software_version: + description: Software Version type: string spoke_ha_config: - $ref: '#/components/schemas/SpokeHAConfigV2' - description: 'The details of the spoke HA configuration. - - ' - sw_obj: - $ref: '#/components/schemas/Software' - description: 'The location and version of the software. - - ' - switch_config: - $ref: '#/components/schemas/SwitchConfig' - description: 'The details of the switch configuration. - - ' + $ref: '#/components/schemas/SpokeHAConfigV1' + description: 'Spoke Ha Config: Valid ' + 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 tags: - description: 'A information field that can be added to identify the element. - - ' + 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) ' items: description: Tags type: string type: array - vpn_to_vpn_forwarding: - description: 'VPN to VPN forwarding. True or False. - - ' - type: boolean required: - site_id - ElementSoftwareState: + ElementQueryFilterV2N3: properties: - download_interval: - description: 'The software download interval. Valid download interval must - be provided along with a valid download time. - - ' - type: integer - id: - description: 'The ID. - - ' - type: string - image_id: - description: 'The element image ID. - - ' + admin_action: + description: Admin Action + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID type: string - interface_ids: - description: 'The software interface IDs. - - ' - items: - description: Interface Ids - type: string - type: array - scheduled_download: - description: 'The scheduled download. - - ' - type: string - scheduled_upgrade: - description: 'The scheduled upgrade. - - ' - type: string - upgrade_interval: - description: 'The upgrade interval of the firmware. Valid upgrade interval - must be provided along with a valid upgrade time. - - ' - type: integer - ElementSoftwareStateScreen: - properties: - download_interval: - description: 'The software download interval. Valid download interval must - be provided along with a valid download time. - - ' - type: integer - id: - description: 'The ID. - - ' - type: string - image_id: - description: 'The element image ID. - - ' + admin_renew_state: + description: Admin Renew State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - interface_ids: - description: 'The software interface IDs. - - ' + allowed_roles: + description: Allowed Roles items: - description: Interface Ids + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string type: array - scheduled_download: - description: 'The scheduled download. - - ' + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - scheduled_upgrade: - description: 'The scheduled upgrade. - - ' + cluster_member_id: + description: Cluster Member Id type: string - upgrade_interval: - description: 'The upgrade interval of the firmware. Valid upgrade interval - must be provided along with a valid upgrade time. - - ' - type: integer - ElementState: - properties: - id: - description: 'The ID. - - ' + 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 - image_id: - description: 'The element image ID. - - ' + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string - scheduled_upgrade: - description: 'The scheduled upgrade. - - ' + hw_id: + description: Hw Id type: string - ElementStateQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of element states that match the query - parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number element states deleted for a time frame. - - ' - type: boolean - group_by: - description: 'Group the element states for the query. - - ' - items: - description: Group By - type: string - type: array id: - description: "List the element state by ID. \n" + description: 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: - 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. - - ' + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding 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 - ElementStateQueryFilter: - properties: - id: - description: 'The ID. - - ' + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + model_name: + description: Model Name type: string - image_id: - description: 'The element image ID. - - ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - scheduled_download: - description: 'The scheduled download. - - ' + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string - scheduled_upgrade: - description: 'The scheduled upgrade. - - ' + network_policysetstack_id: + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - ElementStateScreen: - properties: - id: - description: 'The ID. - - ' + priority_policysetstack_id: + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string - image_id: - description: 'The element image ID. - - ' + role: + description: Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - scheduled_upgrade: - description: 'The scheduled upgrade. - - ' + serial_number: + description: Serial Number type: string - ElementStatusQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of element status that match the query - parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number element status deleted for a time frame. - - ' - type: boolean - group_by: - description: 'Group the element status for the query. - - ' + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + software_version: + description: Software Version + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV1' + description: 'Spoke Ha Config: Valid ' + 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 + 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) ' items: - description: Group By + description: Tags type: string type: array - id: - description: "List the element status by ID. \n" + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding + type: boolean + required: + - site_id + ElementQueryFilterV2N4: + properties: + admin_action: + description: Admin Action + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID 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. - - ' + admin_renew_state: + description: Admin Renew State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION + type: string + allowed_roles: + description: Allowed Roles items: - description: Retrieved Fields + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN 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 - ElementStatusV2N2: - properties: - analytics_backlog_connected: - description: 'The analytics backlog is connected. True or False. - - ' - type: boolean - analytics_backlog_connected_on_utc: - description: 'The analytics backlog is connected on utc. - - ' - format: int64 - type: integer - analytics_backlog_disconnected_on_utc: - description: "The analytics backlog is disconnected on utc. \n" - format: int64 - type: integer - analytics_backlog_from: - description: 'The IPv4 address of the analytics backlog. - - ' + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - analytics_live_connected: - description: "The live analytics is connected. True or False. \n" + cluster_member_id: + description: Cluster Member Id + type: string + connected: + description: Connected type: boolean - analytics_live_connected_on_utc: - description: "The live analytics is connected on utc. \n" - format: int64 - type: integer - analytics_live_disconnected_on_utc: - description: 'The live analytics is disconnected on utc. - - ' - format: int64 - type: integer - analytics_live_from: - description: 'The IPv4 address of the live analytics. - - ' - type: string - config_and_events_connected: - description: "The config and events are connected. True or False. \n" - type: boolean - 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: "The config and events are disconnected on utc. \n" - format: int64 - type: integer - config_and_events_from: - description: 'The IPv4 address for config and events. - - ' - type: string - element_id: - description: "The element ID. \n" + 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 - flows_backlog_connected: - description: "The flows backlog is connected. True or False. \n" - type: boolean - flows_backlog_connected_on_utc: - description: 'The flows backlog is connected on utc. - - ' - format: int64 - type: integer - flows_backlog_disconnected_on_utc: - description: "The flows backlog is disconnected on utc. \n" - format: int64 - type: integer - flows_backlog_from: - description: 'The IPv4 address of the flow backlog. - - ' + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string - flows_live_connected: - description: "The live flows is connected. True or False. \n" - type: boolean - flows_live_connected_on_utc: - description: 'The live flows are connected on utc. - - ' - format: int64 - type: integer - flows_live_disconnected_on_utc: - description: "The live flows are disconnected on utc. \n" - format: int64 - type: integer - flows_live_from: - description: 'The IPV4 address of live flows. - - ' + hw_id: + description: Hw Id type: string 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" + description: Id type: string - last_rebooted_time: - description: 'The last reboot time. - - ' - format: int64 - type: integer - logs_backlog_connected: - description: 'The backlog logs are connected. True or False. - - ' + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding type: boolean - logs_backlog_connected_on_utc: - description: "The backlog logs are connected on utc. \n" - format: int64 - type: integer - logs_backlog_disconnected_on_utc: - description: 'The backlog logs disconnected on utc. - - ' - format: int64 - type: integer - logs_backlog_from: - description: 'The IPV4 address for logs backlog. - - ' - type: string - logs_live_connected: - description: 'The connected live logs. True or False. - - ' + l3_lan_forwarding: + description: L3 Lan Forwarding 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: 'The live logs are disconnected on utc. - - ' - format: int64 - type: integer - logs_live_from: - description: "The IPv4 address from the live logs. \n" - type: string - main_max_power_supported: - description: 'The main max power supported. - - ' - format: int32 - type: integer - main_power_allocated: - description: 'The main power allocated. - - ' - format: float - type: number - main_power_usage_threshold: - description: "The main power usage threshold. \n" - format: int32 - type: integer - poe_state: - description: 'The poe_state. - - ' - type: string - site_id: - description: "The site ID. \n" + model_name: + description: Model Name type: string - switch_state: - $ref: '#/components/schemas/SwitchState' - description: 'The switch state. - - ' - required: - - site_id - ElementStatusV2N3: - properties: - analytics_backlog_connected: - description: 'The analytics backlog is connected. True or False. - - ' - type: boolean - analytics_backlog_connected_on_utc: - description: 'The analytics backlog is connected on utc. - - ' - format: int64 - type: integer - analytics_backlog_disconnected_on_utc: - description: "The analytics backlog is disconnected on utc. \n" - format: int64 - type: integer - analytics_backlog_from: - description: 'The IPv4 address of the analytics backlog. - - ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - analytics_live_connected: - description: "The live analytics is connected. True or False. \n" - type: boolean - analytics_live_connected_on_utc: - description: "The live analytics is connected on utc. \n" - format: int64 - type: integer - analytics_live_disconnected_on_utc: - description: 'The live analytics is disconnected on utc. - - ' - format: int64 - type: integer - analytics_live_from: - description: 'The IPv4 address of the live analytics. - - ' + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' 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 - 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: "The config and events are disconnected on utc. \n" - format: int64 - type: integer - config_and_events_from: - description: 'The IPv4 address for config and events. - - ' + network_policysetstack_id: + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - controller_connection_intf: - description: Controller Connection Intf + priority_policysetstack_id: + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string - device_mode: - description: Device Mode + role: + description: Role enum: - - none - - l3-mode - - l2-mode - type: string - element_id: - description: "The element ID. \n" + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - flows_backlog_connected: - description: "The flows backlog is connected. True or False. \n" - type: boolean - flows_backlog_connected_on_utc: - description: 'The flows backlog is connected on utc. - - ' - format: int64 - type: integer - flows_backlog_disconnected_on_utc: - description: "The flows backlog is disconnected on utc. \n" - format: int64 - type: integer - flows_backlog_from: - description: 'The IPv4 address of the flow backlog. - - ' + serial_number: + description: Serial Number type: string - flows_live_connected: - description: "The live flows is connected. True or False. \n" - type: boolean - flows_live_connected_on_utc: - description: 'The live flows are connected on utc. - - ' - format: int64 - type: integer - flows_live_disconnected_on_utc: - description: "The live flows are disconnected on utc. \n" - format: int64 - type: integer - flows_live_from: - description: 'The IPV4 address of live flows. - - ' + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' type: string - id: - description: 'The element ID. - - ' + software_version: + description: Software Version type: string - last_disconnected_time: - description: 'The last disconnected time. - - ' - format: int64 - type: integer - last_rebooted_info: - description: "Information on the last reboot. \n" + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + 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 - last_rebooted_time: - description: 'The last reboot time. - - ' - format: int64 - type: integer - logs_backlog_connected: - description: 'The backlog logs are connected. True or False. - - ' - type: boolean - logs_backlog_connected_on_utc: - description: "The backlog logs are connected on utc. \n" - format: int64 - type: integer - logs_backlog_disconnected_on_utc: - description: 'The backlog logs disconnected on utc. - - ' - format: int64 - type: integer - logs_backlog_from: - description: 'The IPV4 address for logs backlog. - - ' - type: string - logs_live_connected: - description: 'The connected live logs. True or False. - - ' + 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) ' + items: + description: Tags + type: string + type: array + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding 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: 'The live logs are disconnected on utc. - - ' - format: int64 - type: integer - logs_live_from: - description: "The IPv4 address from the live logs. \n" - type: string - main_max_power_supported: - description: 'The main max power supported. - - ' - format: int32 - type: integer - main_power_allocated: - description: 'The main power allocated. - - ' - format: float - type: number - main_power_usage_threshold: - description: "The main power usage threshold. \n" - format: int32 - type: integer - poe_state: - description: 'The poe_state. - - ' - type: string - site_id: - description: "The site ID. \n" - type: string - switch_state: - $ref: '#/components/schemas/SwitchState' - description: 'The switch state. - - ' required: - site_id - ElementV3: + ElementQueryFilterV2N5: properties: admin_action: - description: 'The values of admin actions that can be performed. - - ' + description: Admin Action enum: - ALLOCATE - CLAIM @@ -2690,9 +2294,7 @@ components: - INVALID type: string admin_renew_state: - description: 'The values of admin renew state. - - ' + description: Admin Renew State enum: - SLEEP - INIT @@ -2765,7 +2367,7 @@ components: - DECOMMISSION type: string admin_suspend_state: - description: "The values of the admin suspend state. \n" + description: Admin Suspend State enum: - SLEEP - INIT @@ -2838,7 +2440,7 @@ components: - DECOMMISSION type: string allowed_roles: - description: "The allowed roles. \n" + description: Allowed Roles items: description: Allowed Roles enum: @@ -2850,18 +2452,17 @@ components: - PA_CONN type: string type: array - cluster_id: - description: Cluster Id + cluster_insertion_mode: + description: Cluster Insertion Mode + type: string + cluster_member_id: + description: Cluster Member Id type: string connected: - description: 'The element is connected. True or False. - - ' + description: Connected type: boolean deployment_op: - description: 'The deployment values. - - ' + description: Deployment Op enum: - DECLAIM - UPGRADE @@ -2881,97 +2482,55 @@ components: - GET_MAC_ADDRESS_TABLE type: string description: - description: 'The description of the element. - - ' - device_profile_id: - description: 'The device profile ID. - - ' + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string fips_mode: - description: 'The FIPs mode. - - ' + description: Fips Mode enum: - none - fips - non_fips type: string fips_mode_change_start_time: - description: 'The FIPs mode change starting time. - - ' + description: Fips Mode Change Start Time format: int64 type: integer hw_id: - description: 'The hardware ID. - - ' + description: Hw Id type: string id: description: Id type: string l3_direct_private_wan_forwarding: - description: 'The L3 direct private WAN is enabled. True or False. - - ' + description: L3 Direct Private Wan Forwarding type: boolean 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. - - ' + description: L3 Lan Forwarding type: boolean - led_config: - $ref: '#/components/schemas/LedConfig' - description: 'Valid LED config. - - ' - main_power_usage_threshold: - description: "The main power usage threshold. Allowed range is 50-100. \ - \ \n" - format: int32 - type: integer model_name: - description: "The model name of the device. \n" + description: Model Name type: string name: - description: 'The name of the device. - - ' + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string nat_policysetstack_id: - description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack - API. - - ' + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string network_policysetstack_id: - description: 'The ID for the Path Policyset Stack. Can be retrieved using - networkpolicysetstack API. - - ' + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - override_indicator: - description: 'The override indicator. - - ' - items: - description: Override Indicator - type: string - type: array priority_policysetstack_id: - description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack - API. - - ' + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string role: - description: 'The element role. - - ' + description: Role enum: - NONE - HUB @@ -2981,29 +2540,20 @@ components: - PA_CONN type: string serial_number: - description: 'The serial number. - - ' + description: Serial Number type: string site_id: - description: 'The site ID. - - ' + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' type: string software_version: - description: 'The software version. - - ' + description: Software Version type: string spoke_ha_config: $ref: '#/components/schemas/SpokeHAConfigV2' - description: 'The details of the spoke HA configuration. - - ' + description: 'Spoke Ha Config: Valid ' state: - description: 'The element state. - - ' + description: State enum: - ACTIVE_INIT - ACTIVE_INVENTORY_IN_PROGRESS @@ -3022,32 +2572,24 @@ components: - OOS - ACTIVE_DECLAIM_IN_PROGRESS type: string - switch_config: - $ref: '#/components/schemas/SwitchConfig' - description: 'The details of the switch configuration. - - ' tags: - description: 'A information field that can be added to identify the element. - - ' + 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) ' items: description: Tags type: string type: array vpn_to_vpn_forwarding: - description: 'VPN to VPN forwarding. True or False. - - ' + description: Vpn To Vpn Forwarding type: boolean required: - site_id - ElementV3N1: + ElementQueryFilterV2N6: properties: admin_action: - description: 'The values of admin actions that can be performed. - - ' + description: Admin Action enum: - ALLOCATE - CLAIM @@ -3064,9 +2606,7 @@ components: - INVALID type: string admin_renew_state: - description: 'The values of admin renew state. - - ' + description: Admin Renew State enum: - SLEEP - INIT @@ -3139,7 +2679,7 @@ components: - DECOMMISSION type: string admin_suspend_state: - description: "The values of the admin suspend state. \n" + description: Admin Suspend State enum: - SLEEP - INIT @@ -3212,7 +2752,7 @@ components: - DECOMMISSION type: string allowed_roles: - description: "The allowed roles. \n" + description: Allowed Roles items: description: Allowed Roles enum: @@ -3224,18 +2764,17 @@ components: - PA_CONN type: string type: array - cluster_id: - description: "The spoke HA config cluster ID. \n" + cluster_insertion_mode: + description: Cluster Insertion Mode + type: string + cluster_member_id: + description: Cluster Member Id type: string connected: - description: 'The element is connected. True or False. - - ' + description: Connected type: boolean deployment_op: - description: 'The deployment values. - - ' + description: Deployment Op enum: - DECLAIM - UPGRADE @@ -3255,123 +2794,70 @@ components: - GET_MAC_ADDRESS_TABLE type: string description: - 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 + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string device_profile_id: - description: 'The device profile ID. - - ' + description: Device Profile Id type: string fips_mode: - description: 'The FIPs mode. - - ' + description: Fips Mode enum: - none - fips - non_fips type: string fips_mode_change_start_time: - description: 'The FIPs mode change starting time. - - ' + description: Fips Mode Change Start Time format: int64 type: integer hw_id: - description: 'The hardware ID. - - ' + description: Hw Id type: string id: description: Id type: string l3_direct_private_wan_forwarding: - description: 'The L3 direct private WAN is enabled. True or False. - - ' + description: L3 Direct Private Wan Forwarding type: boolean 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. - - ' + description: L3 Lan Forwarding type: boolean - led_config: - $ref: '#/components/schemas/LedConfig' - description: 'Valid LED config. - - ' main_power_usage_threshold: - description: "The main power usage threshold. Allowed range is 50-100. \ - \ \n" + 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) ' format: int32 type: integer model_name: - description: "The model name of the device. \n" + description: Model Name type: string name: - description: 'The name of the device. - - ' + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string nat_policysetstack_id: - description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack - API. - - ' + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string network_policysetstack_id: - description: 'The ID for the Path Policyset Stack. Can be retrieved using - networkpolicysetstack API. - - ' + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string override_indicator: - description: 'The override indicator. - - ' + description: Override Indicator items: description: Override Indicator type: string type: array priority_policysetstack_id: - description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack - API. - - ' + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string role: - description: 'The element role. - - ' + description: Role enum: - NONE - HUB @@ -3381,29 +2867,20 @@ components: - PA_CONN type: string serial_number: - description: 'The serial number. - - ' + description: Serial Number type: string site_id: - description: 'The site ID. - - ' + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' type: string software_version: - description: 'The software version. - - ' + description: Software Version type: string spoke_ha_config: $ref: '#/components/schemas/SpokeHAConfigV2' - description: 'The details of the spoke HA configuration. - - ' + description: 'Spoke Ha Config: Valid ' state: - description: 'The element state. - - ' + description: State enum: - ACTIVE_INIT - ACTIVE_INVENTORY_IN_PROGRESS @@ -3424,5087 +2901,17829 @@ components: type: string switch_config: $ref: '#/components/schemas/SwitchConfig' - description: 'The details of the switch configuration. - - ' + description: 'Switch Config: Valid ' tags: - description: 'A information field that can be added to identify the element. - - ' + 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) ' items: description: Tags type: string type: array vpn_to_vpn_forwarding: - description: 'VPN to VPN forwarding. True or False. - - ' + description: Vpn To Vpn Forwarding type: boolean required: - site_id - Error: - properties: - _error: - items: - $ref: '#/components/schemas/ErrorResponse' - type: array - ErrorResponse: + ElementQueryFilterV2N7: properties: - code: - description: 'The error code. - - ' + admin_action: + description: Admin Action + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID type: string - message: - description: 'The error message. - - ' + admin_renew_state: + description: Admin Renew State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - Ethernet: - properties: - connector: - description: "The ethernet connector type. \n" + admin_suspend_state: + description: Admin Suspend State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - device: - description: "The device name. \n" + allowed_roles: + description: Allowed Roles + items: + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + type: array + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - disabled: - description: 'Disable the port. - - ' + cluster_member_id: + description: Cluster Member Id + type: string + connected: + description: Connected type: boolean - disabled_reason: - description: 'Reason to disable the port. - - ' + 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 - element_id: - description: 'Element ID. - - ' + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string - id: - description: 'The connector ID. - - ' + device_profile_id: + description: Device Profile Id type: string - inactive: - description: 'Port status (active or inactive). - - ' - type: boolean - inactive_reason: - description: 'Reason for port being inactive. - - ' + fips_mode: + description: Fips Mode + enum: + - none + - fips + - non_fips type: string - max_mtu: - description: 'The MTU max value. - - ' - type: integer - max_speed: - description: 'The max speed value. - - ' + fips_mode_change_start_time: + description: Fips Mode Change Start Time + format: int64 type: integer - name: - description: 'The name. - - ' - type: string - original_mac_address: - description: 'The MAC address. - - ' - type: string - region: - description: 'The region. - - ' + hw_id: + description: Hw Id type: string - site_id: - description: 'The site ID. - - ' + id: + description: Id type: string - required: - - site_id - EthernetPort: - properties: - full_duplex: - description: 'Interface running in full duplex mode. - - ' + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding type: boolean - port_id: - $ref: '#/components/schemas/Ethernet' - description: 'The ethernet port ID. - - ' - port_name: - description: 'The ethernet port name. - - ' - type: string - speed: - description: "The ethernet port speed. \n" + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + led_config: + $ref: '#/components/schemas/LedConfig' + description: 'Led Config: Valid ' + 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) ' format: int32 type: integer - Extension: - properties: - conf: - type: object - disabled: - description: 'List the disabled extensions. - - ' - type: boolean - entity_id: - description: 'The entity ID. Only numbers are allowed (0-9). - - ' - type: string - id: - description: 'The ID. - - ' + model_name: + description: Model Name type: string name: - description: "The name of the extension. Max size = 128. \n" + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - namespace: - description: "The extension namespace. Values = ^[a-z][a-z0-9/]*[a-z0-9]+$\ - \ \n" + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string - required: - - conf - - namespace - - name - ExtensionQuery: - 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 + network_policysetstack_id: + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' + type: string + override_indicator: + description: Override Indicator items: - description: Group By + description: Override Indicator type: string type: array - id: - description: 'The ID. - - ' + priority_policysetstack_id: + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack 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 + role: + description: Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + 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_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + 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 + switch_config: + $ref: '#/components/schemas/SwitchConfig' + description: 'Switch Config: Valid ' + 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) ' items: - description: Retrieved Fields + description: Tags 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 - ExtensionQueryFilter: - properties: - conf: - type: object - disabled: - description: 'List the disabled extensions. - - ' + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding type: boolean - id: - description: 'The ID. - - ' - type: string - name: - 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]+$\ - \ \n" - type: string required: - - conf - - namespace - - name - ExtensionScreen: + - site_id + ElementQueryFilterV3: properties: - conf: - type: object - disabled: - description: 'List the disabled extensions. - - ' - type: boolean - entity_id: - description: 'The entity ID. Only numbers are allowed (0-9). - - ' - type: string - id: - description: 'The ID. + admin_action: + description: 'The values of admin actions that can be performed. ' + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID type: string - name: - 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]+$. + admin_renew_state: + description: 'The values of admin renew state. ' - type: string - required: - - conf - - namespace - - name - GREConfig: - properties: - csum: - description: 'The CSUM. + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION + type: string + admin_suspend_state: + description: "The values of the admin suspend state. \n" + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION + 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_id: + description: Cluster Id + type: string + connected: + description: 'The element is connected. True or False. ' type: boolean - keepalive_enable: - description: 'Is keepalive enabled. True or False. + deployment_op: + description: 'The deployment values. ' - 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. + 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. ' - 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. + device_profile_id: + description: 'The device profile ID. ' - format: int32 + type: string + fips_mode: + description: 'The FIPs mode. + + ' + enum: + - none + - fips + - non_fips + type: string + fips_mode_change_start_time: + description: 'The FIPs mode change starting time. + + ' + format: int64 type: integer - GeneveConfig: - properties: - keepalive_enable: - description: 'Is keepalive enabled. True or False. + hw_id: + description: 'The hardware ID. + + ' + type: string + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: 'The L3 direct private WAN is 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. + 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. ' - 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. + type: boolean + led_config: + $ref: '#/components/schemas/LedConfig' + description: 'Valid LED config. ' + main_power_usage_threshold: + description: "The main power usage threshold. Allowed range is 50-100. \ + \ \n" format: int32 type: integer - keepalive_local_ipv4: - description: 'The keepalive local ipv4 address. - - ' + model_name: + description: "The model name of the device. \n" type: string - keepalive_remote_ipv4: - description: 'The keepalive remote ipv4 address. + name: + description: 'The name of the device. ' type: string - HardwareBypass: - properties: - element_bypass: - description: "The information on the element bypass pair. \n" - items: - $ref: '#/components/schemas/BypassInfo' - type: array - id: - description: 'The ID. + nat_policysetstack_id: + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. ' type: string - IKEV1Params: - properties: - xauth_id: - description: 'The xauth ID. + network_policysetstack_id: + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. ' type: string - xauth_secret: - description: 'The authentication secret. Length must be between 4-128. + override_indicator: + description: 'The override indicator. ' - type: string - xauth_secret_encrypted: - description: "The xauth secret. Value = True. \n" - type: string - xauth_secret_hash: - description: 'The xauth hash. Value = True. + items: + description: Override Indicator + type: string + type: array + priority_policysetstack_id: + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. ' type: string - xauth_type: - description: 'The xauth type. + role: + description: 'The element role. ' enum: - NONE - - SECRET + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - required: - - xauth_type - IPSECAuthentication: - properties: - certificate: - description: 'The certificate authentication for the IPsec Profile. + serial_number: + description: 'The serial number. ' 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 ' - local_ca_certificate: - description: "The local CA certificate uploaded for certificate authentication.\ - \ \n" - type: string - local_id: - description: 'The local ID type. + site_id: + description: 'The site ID. ' - enum: - - LOCAL_IP - - DN - - HOSTNAME - - CUSTOM - - NONE type: string - local_id_custom: - description: 'The custom local ID. + software_version: + description: 'The software version. ' 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. + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'The details of the spoke HA configuration. ' - type: string - private_key_encrypted: - description: 'Private Key Encrypted: JsonIgnore(value = true) ' - type: string - remote_ca_certificate: - description: "The standard VPN endpoint CA certificate uploaded. \ - \ \n" - type: string - remote_id: - description: "The ID for the standard VPN endpoint in the Remote ID field.\ - \ \n" - type: string - secret: - description: "The password for PSK authentication. \n" - type: string - secret_encrypted: - description: 'Secret Encrypted: JsonIgnore(value = true) ' - type: string - 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. + state: + description: 'The element state. ' enum: - - NONE - - PSK - - X509 - type: string - x509Objects: - $ref: '#/components/schemas/X509Objects' - description: 'X509Objects: JsonIgnore(value = true) ' - required: - - local_id - - type - IPSECConfig: - properties: - authentication: - $ref: '#/components/schemas/IPSECAuthentication' - description: 'The IPSec authentication details. - - ' - ipsec_profile_id: - description: 'The IPSec profile ID. - - ' + - 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: - - ipsec_profile_id - IPv4Range: - properties: - end: - description: 'The end IPv4 address. + switch_config: + $ref: '#/components/schemas/SwitchConfig' + description: 'The details of the switch configuration. ' - type: string - start: - description: "The start IPv4 address. \n" - type: string - required: - - end - - start - IPv6DNS: - properties: - name_servers: - description: 'The IPv6 configured DNS name servers. + tags: + description: 'A information field that can be added to identify the element. ' items: - description: Name Servers + description: Tags type: string type: array - search: - description: 'The search parameters. + vpn_to_vpn_forwarding: + description: 'VPN to VPN forwarding. True or False. ' - items: - description: Search - type: string - type: array - InterfaceScreenV4N16: + type: boolean + required: + - site_id + ElementScreen: properties: - admin_up: - description: 'The interface admin state. + cluster_insertion_mode: + description: "The cluster insertion mode. \n" + type: string + cluster_member_id: + description: 'The cluster member ID. ' - type: boolean - attached_lan_networks: - description: 'The attached lan network ID and vlan ID. + type: string + description: + description: 'The description of the element. ' - items: - $ref: '#/components/schemas/LanNetworkVlanMapping' - type: array - authentication_config: - $ref: '#/components/schemas/AuthenticationInterfaceConfig' - description: 'The authentication config details. + id: + description: Id + type: string + name: + description: 'The name of the element. ' - bound_interfaces: - description: 'The bound interfaces. + type: string + site_id: + description: 'The site ID. ' - items: - description: Bound Interfaces - type: string - type: array - bypass_pair: - $ref: '#/components/schemas/BypassPairV2' - description: 'The details of the bypass pair. + type: string + sw_obj: + $ref: '#/components/schemas/Software' + description: 'The location and version of the software. ' - cellular_config: - $ref: '#/components/schemas/CellularInterfaceConfig' - description: 'The cellular config details. + required: + - site_id + ElementScreenV2N1: + properties: + cluster_insertion_mode: + description: "The cluster insertion mode. \n" + type: string + cluster_member_id: + description: 'The cluster member ID. ' + type: string description: - description: 'The interface description. Max size = 256. - - ' - devicemgmt_policysetstack_id: - description: 'The device management policy set stack ID. + description: 'The description of the element. ' + id: + description: Id type: string - dhcp_relay: - $ref: '#/components/schemas/DHCPRelay' - description: 'The DHCP relay information. - - ' - directed_broadcast: - description: 'The directed broadcast. + l3_direct_private_wan_forwarding: + description: 'The L3 direct private WAN is enabled. True or False. ' type: boolean - ethernet_port: - $ref: '#/components/schemas/EthernetPort' - description: 'The ethernet port information. - - ' - id: - description: 'The interface ID. + 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 + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - interface_profile_id: - description: 'The interface profile ID. + network_policysetstack_id: + description: 'The network policy stack ID. ' type: string - ipfixcollectorcontext_id: - description: 'The IPFIX collector context ID. + priority_policysetstack_id: + description: 'The priority policy set stack ID. ' type: string - ipfixfiltercontext_id: - description: 'The IPFIX filter context ID. + site_id: + description: 'The site ID. ' type: string - ipv4_config: - $ref: '#/components/schemas/Ipv4Config' - description: 'The ipv4 config information. - - ' - ipv6_config: - $ref: '#/components/schemas/Ipv6ConfigV1' - description: 'The ipv6 config information. - - ' - lldp_enabled: - description: 'If LLDP enabled. True/False. - - ' - type: boolean - mac_address: - description: 'The interface configuration MAC address. + sw_obj: + $ref: '#/components/schemas/Software' + description: 'The location and version of the software object. ' + required: + - site_id + ElementScreenV2N2: + properties: + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - mtu: - description: 'The MTU value of the interface. - - ' - type: integer - multicast_config: - $ref: '#/components/schemas/MulticastInterfaceConfig' - description: 'The multicast config details. - - ' + cluster_member_id: + description: Cluster Member Id + type: string + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean name: - description: 'The name of the interface state. Max size = 128. - - ' + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - nat_address: - description: 'The NAT IP address. - - ' + network_policysetstack_id: + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - nat_address_v6: - description: 'The NAT IPV6 address. - - ' + priority_policysetstack_id: + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string - nat_pools: - description: 'The NAT pools information. - - ' + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV1' + description: 'Spoke Ha Config: Valid ' + sw_obj: + $ref: '#/components/schemas/Software' + description: Sw Obj + 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) ' items: - $ref: '#/components/schemas/NatPool' + description: Tags + type: string type: array - nat_port: - description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part - of logical interface groups. - - ' - format: int32 - type: integer - nat_port_v6: - description: "The NAT IPv6 port.Internet bypass ports cannot be part of\ - \ logical interface groups. \n" - format: int32 - type: integer - nat_zone_id: - description: 'The NAT zone ID. - - ' + required: + - site_id + ElementScreenV2N3: + properties: + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - network_context_id: - description: 'The network context ID. - - ' + cluster_member_id: + description: Cluster Member Id type: string - parent: - description: 'The parent value = true. - - ' + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string - peer_bypasspair_wan_port_type: - description: 'The peer bypass pair WAN port type. - - ' - enum: - - none - - cellular + id: + description: Id type: string - poe_enabled: - description: 'PoE enabled = true/false. - - ' + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding type: boolean - power_usage_threshold: - description: 'The interface config PoE power usage threshold. Valid values - are in the range 50-100. - - ' - format: int32 - type: integer - pppoe_config: - $ref: '#/components/schemas/PppoEInterfaceConfig' - description: 'The PPPoE config information. - - ' - scope: - description: 'The network scope. - - ' - enum: - - GLOBAL - - LOCAL + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - secondary_ip_configs: - description: 'The interface secondary IP config. Secondary IPs exceed the - supported limit of 8. - - ' - items: - $ref: '#/components/schemas/SecondaryIPConfig' - type: array - service_link_config: - $ref: '#/components/schemas/ServiceLinkV2' - description: 'The interface secondary IP config. Secondary IPs exceed the - supported limit of 8. - - ' - site_wan_interface_ids: - description: 'The site WAN interface IDs. - - ' + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' + 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) ' + 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) ' + type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV1' + description: 'Spoke Ha Config: Valid ' + sw_obj: + $ref: '#/components/schemas/Software' + description: Sw Obj + 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) ' items: - description: Site Wan Interface Ids + description: Tags type: string type: array - static_arp_configs: - description: 'The static ARP config details. - - ' - items: - $ref: '#/components/schemas/StaticARPConfig' - type: array - sub_interface: - $ref: '#/components/schemas/SubInterface' - description: 'The sub interface vlan ID. - - ' - switch_port_config: - $ref: '#/components/schemas/SwitchPortConfig' - description: 'The switch port config details. - - ' + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding + type: boolean + required: + - site_id + ElementScreenV2N4: + properties: + cluster_insertion_mode: + description: Cluster Insertion Mode + type: string + cluster_member_id: + description: Cluster Member Id + type: string + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + 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.) ' + 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) ' + 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) ' + type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + sw_obj: + $ref: '#/components/schemas/Software' + description: Sw Obj tags: - description: 'A information field that can be added to identify the interface. - Maximum 10 Unique tags of length 1024 each are allowed. - - ' + 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) ' items: description: Tags type: string type: array - type: - description: 'The interface type. - - ' + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding + type: boolean + required: + - site_id + ElementScreenV2N5: + properties: + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - used_for: - description: 'The interface used for value. The allowed values are public,private_wan,lan,none. - - ' + cluster_member_id: + description: Cluster Member Id type: string - vlan_config: - $ref: '#/components/schemas/VlanConfig' - description: 'The VLAN config details. - - ' - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. - - ' + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + 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.) ' 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) ' + 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) ' + type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + sw_obj: + $ref: '#/components/schemas/Software' + description: Sw Obj + 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) ' + items: + description: Tags + type: string + type: array + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding + type: boolean required: - - peer_bypasspair_wan_port_type - - scope - - used_for - - type - InterfaceScreenV4N17: + - site_id + ElementScreenV2N6: properties: - admin_up: - description: 'The interface admin state. - - ' + cluster_insertion_mode: + description: Cluster Insertion Mode + type: string + cluster_member_id: + description: Cluster Member Id + type: string + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + device_profile_id: + description: Device Profile Id + type: string + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding type: boolean - attached_lan_networks: - description: 'The attached lan network ID and vlan ID. - - ' + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + 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) ' + format: int32 + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + 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.) ' + 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) ' + 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) ' + type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + sw_obj: + $ref: '#/components/schemas/Software' + description: Sw Obj + switch_config: + $ref: '#/components/schemas/SwitchConfig' + description: 'Switch Config: Valid ' + 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) ' items: - $ref: '#/components/schemas/LanNetworkVlanMapping' + description: Tags + type: string type: array - authentication_config: - $ref: '#/components/schemas/AuthenticationInterfaceConfig' - description: 'The authentication config details. - - ' - bound_interfaces: - description: 'The bound interfaces. - - ' + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding + type: boolean + required: + - site_id + ElementScreenV2N7: + properties: + cluster_insertion_mode: + description: Cluster Insertion Mode + type: string + cluster_member_id: + description: Cluster Member Id + type: string + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + device_profile_id: + description: Device Profile Id + type: string + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + led_config: + $ref: '#/components/schemas/LedConfig' + description: 'Led Config: Valid ' + 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) ' + format: int32 + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + 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.) ' + 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) ' + 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) ' + type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + sw_obj: + $ref: '#/components/schemas/Software' + description: Sw Obj + switch_config: + $ref: '#/components/schemas/SwitchConfig' + description: 'Switch Config: Valid ' + 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) ' items: - description: Bound Interfaces + description: Tags type: string type: array - bypass_pair: - $ref: '#/components/schemas/BypassPairV2' - description: 'The details of the bypass pair. - - ' - cellular_config: - $ref: '#/components/schemas/CellularInterfaceConfig' - description: 'The cellular config details. - - ' + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding + type: boolean + required: + - site_id + ElementScreenV3: + properties: + cluster_id: + description: "The cluster ID. \n" + type: string description: - description: 'The interface description. Max size = 256. - - ' - devicemgmt_policysetstack_id: - description: 'The device management policy set stack ID. + description: 'The description of the element. ' + device_profile_id: + description: "The device profile ID. \n" type: string - dhcp_relay: - $ref: '#/components/schemas/DHCPRelay' - description: 'The DHCP relay information. + id: + description: "The element ID. \n" + type: string + l3_direct_private_wan_forwarding: + description: 'The L3 direct private WAN is enabled. True or False. ' - directed_broadcast: - description: 'The directed broadcast. + type: boolean + 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 - ethernet_port: - $ref: '#/components/schemas/EthernetPort' - description: 'The ethernet port information. + led_config: + $ref: '#/components/schemas/LedConfig' + description: 'Valid LED config. ' - id: - description: 'The interface ID. + main_power_usage_threshold: + description: "The main power usage threshold. Allowed range is 50-100. \ + \ \n" + format: int32 + type: integer + name: + description: 'The name of the device. ' type: string - interface_profile_id: - description: 'The interface profile ID. + nat_policysetstack_id: + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. ' type: string - ipfixcollectorcontext_id: - description: 'The IPFIX collector context ID. + network_policysetstack_id: + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. ' type: string - ipfixfiltercontext_id: - description: 'The IPFIX filter context ID. + priority_policysetstack_id: + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. ' type: string - ipv4_config: - $ref: '#/components/schemas/Ipv4Config' - description: 'The ipv4 config information. + site_id: + description: "The site ID. \n" + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'The details of the spoke HA configuration. ' - ipv6_config: - $ref: '#/components/schemas/Ipv6ConfigV1' - description: 'The ipv6 config information. + sw_obj: + $ref: '#/components/schemas/Software' + description: 'The location and version of the software. ' - lldp_enabled: - description: 'If LLDP enabled. True/False. + switch_config: + $ref: '#/components/schemas/SwitchConfig' + description: 'The details of the switch configuration. ' - type: boolean - mac_address: - description: 'The interface configuration MAC address. + tags: + description: 'A information field that can be added to identify the element. ' - type: string - mtu: - description: 'The MTU value of the interface. + items: + description: Tags + type: string + type: array + vpn_to_vpn_forwarding: + description: 'VPN to VPN forwarding. True or False. + + ' + type: boolean + required: + - site_id + ElementSoftwareState: + properties: + download_interval: + description: 'The software download interval. Valid download interval must + be provided along with a valid download time. ' type: integer - multicast_config: - $ref: '#/components/schemas/MulticastInterfaceConfig' - description: 'The multicast config details. + id: + description: 'The ID. ' - name: - description: 'The name of the interface state. Max size = 128. + type: string + image_id: + description: 'The element image ID. ' type: string - nat_address: - description: 'The NAT IP address. + interface_ids: + description: 'The software interface IDs. ' - type: string - nat_address_v6: - description: 'The NAT IPV6 address. + items: + description: Interface Ids + type: string + type: array + scheduled_download: + description: 'The scheduled download. ' type: string - nat_pools: - description: 'The NAT pools information. + scheduled_upgrade: + description: 'The scheduled upgrade. ' - items: - $ref: '#/components/schemas/NatPool' - type: array - nat_port: - description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part - of logical interface groups. + type: string + upgrade_interval: + description: 'The upgrade interval of the firmware. Valid upgrade interval + must be provided along with a valid upgrade time. ' - format: int32 type: integer - nat_port_v6: - description: "The NAT IPv6 port.Internet bypass ports cannot be part of\ - \ logical interface groups. \n" - format: int32 + ElementSoftwareStateScreen: + properties: + download_interval: + description: 'The software download interval. Valid download interval must + be provided along with a valid download time. + + ' type: integer - nat_zone_id: - description: 'The NAT zone ID. + id: + description: 'The ID. ' type: string - network_context_id: - description: 'The network context ID. + image_id: + description: 'The element image ID. ' type: string - parent: - description: 'The parent value = true. + interface_ids: + description: 'The software interface IDs. ' - type: string - peer_bypasspair_wan_port_type: - description: 'The peer bypass pair WAN port type. + items: + description: Interface Ids + type: string + type: array + scheduled_download: + description: 'The scheduled download. ' - enum: - - none - - cellular type: string - poe_enabled: - description: 'PoE enabled = true/false. + scheduled_upgrade: + description: 'The scheduled upgrade. ' - type: boolean - power_usage_threshold: - description: 'The interface config PoE power usage threshold. Valid values - are in the range 50-100. + type: string + upgrade_interval: + description: 'The upgrade interval of the firmware. Valid upgrade interval + must be provided along with a valid upgrade time. ' - format: int32 type: integer - pppoe_config: - $ref: '#/components/schemas/PppoEInterfaceConfig' - description: 'The PPPoE config information. + ElementState: + properties: + id: + description: 'The ID. ' - scope: - description: 'The network scope. + type: string + image_id: + description: 'The element image ID. ' - enum: - - GLOBAL - - LOCAL type: string - secondary_ip_configs: - description: 'The interface secondary IP config. Secondary IPs exceed the - supported limit of 8. + scheduled_upgrade: + description: 'The scheduled upgrade. ' - items: - $ref: '#/components/schemas/SecondaryIPConfig' - type: array - service_link_config: - $ref: '#/components/schemas/ServiceLinkV2' - description: 'The interface secondary IP config. Secondary IPs exceed the - supported limit of 8. + type: string + ElementStateQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of element states that match the query + parameters. ' - site_wan_interface_ids: - description: 'The site WAN interface IDs. + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number element states deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the element states for the query. ' items: - description: Site Wan Interface Ids + description: Group By type: string type: array - static_arp_configs: - description: 'The static ARP config details. + id: + description: "List the element state by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. ' - items: - $ref: '#/components/schemas/StaticARPConfig' - type: array - sub_interface: - $ref: '#/components/schemas/SubInterface' - description: 'The sub interface vlan ID. + format: int64 + type: integer + limit: + description: 'The query limit. ' - switch_port_config: - $ref: '#/components/schemas/SwitchPortConfig' - description: 'The switch port config details. + format: int32 + type: integer + next_query: + description: 'The limit. ' - tags: - description: 'A information field that can be added to identify the interface. - Maximum 10 Unique tags of length 1024 each are allowed. + 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 - type: - description: 'The interface type. - - ' - type: string - used_for: - description: 'The interface used for value. The allowed values are public,private_wan,lan,none. + retrieved_fields_mask: + description: 'List the fields to query. ' - type: string - vlan_config: - $ref: '#/components/schemas/VlanConfig' - description: 'The VLAN config details. + type: boolean + sort_params: + description: 'Specify the order in which you want the search criteria to + display. ' - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. + type: object + total_count: + description: 'The total number of query parameters. ' - type: string - required: - - peer_bypasspair_wan_port_type - - scope - - used_for - - type - InterfaceStateV3N5: + format: int64 + type: integer + ElementStateQueryFilter: properties: - cellular_state: - $ref: '#/components/schemas/CellularState' - description: 'The cellular state details. - - ' - device: - description: 'The ION device. + id: + description: 'The ID. ' type: string - dns_v4_config: - $ref: '#/components/schemas/DNS' - description: 'The DNS v4 config details. - - ' - dns_v6_config: - $ref: '#/components/schemas/IPv6DNS' - description: 'The DNS v6 config details. + image_id: + description: 'The element image ID. ' - effective_vlans: - description: Effective Vlans - items: - description: Effective Vlans - type: integer - type: array - element_id: - description: 'The element ID. + type: string + scheduled_download: + description: 'The scheduled download. ' type: string - extended_state: - description: 'The extended state. + scheduled_upgrade: + description: 'The scheduled upgrade. ' type: string + ElementStateScreen: + properties: id: - description: 'The interface ID. + description: 'The ID. ' type: string - ipv4_addresses: - description: "The IPv4 addresses configured for the interface. \n" - items: - description: Ipv4 Addresses - type: string - type: array - ipv6_addresses: - description: "The IPv6 addresses configured for the interface. \n" - items: - description: Ipv6 Addresses - type: string - type: array - last_state_change: - description: 'The last state change of the device. + image_id: + description: 'The element image ID. ' - format: int64 - type: integer - 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. + scheduled_upgrade: + description: 'The scheduled upgrade. ' type: string - name: - description: 'The name of the interface state. Max size = 128. - - ' + ElementStatus: + properties: + analytics_backlog_connected: + description: Analytics Backlog Connected + type: boolean + analytics_backlog_connected_on_utc: + description: Analytics Backlog Connected On Utc + format: int64 + type: integer + analytics_backlog_disconnected_on_utc: + description: Analytics Backlog Disconnected On Utc + format: int64 + type: integer + analytics_backlog_from: + description: Analytics Backlog From type: string - negotiated_mtu: - description: 'The negotiated IP MTU value. - - ' - format: int32 + analytics_live_connected: + description: Analytics Live Connected + type: boolean + analytics_live_connected_on_utc: + description: Analytics Live Connected On Utc + format: int64 type: integer - operational_state: - description: 'The operational state. - - ' + analytics_live_disconnected_on_utc: + description: Analytics Live Disconnected On Utc + format: int64 + type: integer + analytics_live_from: + description: Analytics Live From type: string - poe_state: - $ref: '#/components/schemas/PoeStateS' - description: Poe State - port: - $ref: '#/components/schemas/Port' - description: 'The start and end port details. - - ' - remote_host_name: - description: 'The remote host name. + config_and_events_connected: + description: Config And Events Connected + type: boolean + config_and_events_connected_on_utc: + description: Config And Events Connected On Utc + format: int64 + type: integer + config_and_events_disconnected_on_utc: + description: Config And Events Disconnected On Utc + format: int64 + type: integer + config_and_events_from: + description: Config And Events From + type: string + element_id: + description: Element Id + type: string + flows_backlog_connected: + description: Flows Backlog Connected + type: boolean + flows_backlog_connected_on_utc: + description: Flows Backlog Connected On Utc + format: int64 + type: integer + flows_backlog_disconnected_on_utc: + description: Flows Backlog Disconnected On Utc + format: int64 + type: integer + flows_backlog_from: + description: Flows Backlog From + type: string + flows_live_connected: + description: Flows Live Connected + type: boolean + flows_live_connected_on_utc: + description: Flows Live Connected On Utc + format: int64 + type: integer + flows_live_disconnected_on_utc: + description: Flows Live Disconnected On Utc + format: int64 + type: integer + flows_live_from: + description: Flows Live From + type: string + id: + description: Id + type: string + logs_backlog_connected: + description: Logs Backlog Connected + type: boolean + logs_backlog_connected_on_utc: + description: Logs Backlog Connected On Utc + format: int64 + type: integer + logs_backlog_disconnected_on_utc: + description: Logs Backlog Disconnected On Utc + format: int64 + type: integer + logs_backlog_from: + description: Logs Backlog From + type: string + logs_live_connected: + description: Logs Live Connected + type: boolean + logs_live_connected_on_utc: + description: Logs Live Connected On Utc + format: int64 + type: integer + logs_live_disconnected_on_utc: + description: Logs Live Disconnected On Utc + format: int64 + type: integer + logs_live_from: + description: Logs Live From + type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + required: + - site_id + ElementStatusQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of element status that match the query + parameters. ' - type: string - remote_v4_addr: - description: 'The remote IPv4 address. + dest_page: + description: 'The destination page. ' - type: string - routes: - description: "The routing details. \n" - items: - $ref: '#/components/schemas/Route' - type: array - routes_v6: - description: 'The route v6 details. + format: int32 + type: integer + getDeleted: + description: 'The number element status deleted for a time frame. ' - items: - $ref: '#/components/schemas/Ipv6Route' - type: array - secondary_ipv4_addresses: - description: 'The secondary IPv4 addresses. + type: boolean + group_by: + description: 'Group the element status for the query. ' items: - description: Secondary Ipv4 Addresses + description: Group By type: string type: array - service_link: - $ref: '#/components/schemas/ServiceLink' - description: 'The service link details ServiceLink. - - ' - stp_state: - $ref: '#/components/schemas/STPStateS' - description: 'The STP state details. - - ' - svi_state: - $ref: '#/components/schemas/SVIStateS' - description: 'The svi details. + id: + description: "List the element status by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. ' - InterfaceStateV3N6: - properties: - cellular_state: - $ref: '#/components/schemas/CellularState' - description: 'The cellular state details. + format: int64 + type: integer + limit: + description: 'The query limit. ' - device: - description: 'The ION device. + format: int32 + type: integer + next_query: + description: 'The limit. ' - type: string - dns_v4_config: - $ref: '#/components/schemas/DNS' - description: 'The DNS v4 config details. + type: object + query_params: + description: 'Query using query parameters. ' - dns_v6_config: - $ref: '#/components/schemas/IPv6DNS' - description: 'The DNS v6 config details. + type: object + retrieved_fields: + description: 'Retrieve information from a field. ' - effective_vlans: - description: Effective Vlans items: - description: Effective Vlans - type: integer + description: Retrieved Fields + type: string type: array - element_id: - description: 'The element ID. - - ' - type: string - extended_state: - description: 'The extended state. + retrieved_fields_mask: + description: 'List the fields to query. ' - type: string - id: - description: 'The interface ID. + type: boolean + sort_params: + description: 'Specify the order in which you want the search criteria to + display. ' - type: string - ipv4_addresses: - description: "The IPv4 addresses configured for the interface. \n" - items: - description: Ipv4 Addresses - type: string - type: array - ipv6_addresses: - description: "The IPv6 addresses configured for the interface. \n" - items: - description: Ipv6 Addresses - type: string - type: array - last_state_change: - description: 'The last state change of the device. + type: object + total_count: + description: 'The total number of query parameters. ' format: int64 type: integer - link_local_address: - description: "The link local address. \n" + ElementStatusV2N1: + properties: + analytics_backlog_connected: + description: Analytics Backlog Connected + type: boolean + analytics_backlog_connected_on_utc: + description: Analytics Backlog Connected On Utc + format: int64 + type: integer + analytics_backlog_disconnected_on_utc: + description: Analytics Backlog Disconnected On Utc + format: int64 + type: integer + analytics_backlog_from: + description: Analytics Backlog From type: string - lldp_enabled: - description: Lldp Enabled + analytics_live_connected: + description: Analytics Live Connected type: boolean - mac_address: - description: 'The interface configuration MAC address. - - ' + analytics_live_connected_on_utc: + description: Analytics Live Connected On Utc + format: int64 + type: integer + analytics_live_disconnected_on_utc: + description: Analytics Live Disconnected On Utc + format: int64 + type: integer + analytics_live_from: + description: Analytics Live From type: string - name: - description: 'The name of the interface state. Max size = 128. - - ' + config_and_events_connected: + description: Config And Events Connected + type: boolean + config_and_events_connected_on_utc: + description: Config And Events Connected On Utc + format: int64 + type: integer + config_and_events_disconnected_on_utc: + description: Config And Events Disconnected On Utc + format: int64 + type: integer + config_and_events_from: + description: Config And Events From type: string - negotiated_mtu: - description: 'The negotiated IP MTU value. - - ' - format: int32 + element_id: + description: Element Id + type: string + flows_backlog_connected: + description: Flows Backlog Connected + type: boolean + flows_backlog_connected_on_utc: + description: Flows Backlog Connected On Utc + format: int64 type: integer - operational_state: - description: 'The operational state. - - ' + flows_backlog_disconnected_on_utc: + description: Flows Backlog Disconnected On Utc + format: int64 + type: integer + flows_backlog_from: + description: Flows Backlog From + type: string + flows_live_connected: + description: Flows Live Connected + type: boolean + flows_live_connected_on_utc: + description: Flows Live Connected On Utc + format: int64 + type: integer + flows_live_disconnected_on_utc: + description: Flows Live Disconnected On Utc + format: int64 + type: integer + flows_live_from: + description: Flows Live From + type: string + id: + description: Id + type: string + logs_backlog_connected: + description: Logs Backlog Connected + type: boolean + logs_backlog_connected_on_utc: + description: Logs Backlog Connected On Utc + format: int64 + type: integer + logs_backlog_disconnected_on_utc: + description: Logs Backlog Disconnected On Utc + format: int64 + type: integer + logs_backlog_from: + description: Logs Backlog From + type: string + logs_live_connected: + description: Logs Live Connected + type: boolean + logs_live_connected_on_utc: + description: Logs Live Connected On Utc + format: int64 + type: integer + logs_live_disconnected_on_utc: + description: Logs Live Disconnected On Utc + format: int64 + type: integer + logs_live_from: + description: Logs Live From type: string + main_max_power_supported: + description: Main Max Power Supported + format: int32 + type: integer + main_power_allocated: + description: 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) ' + format: int32 + type: integer poe_state: - $ref: '#/components/schemas/PoeStateS' description: Poe State - port: - $ref: '#/components/schemas/Port' - description: 'The start and end port details. - - ' - remote_host_name: - description: 'The remote host name. - - ' type: string - remote_v4_addr: - description: 'The remote IPv4 address. - - ' + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' type: string - routes: - description: "The routing details. \n" - items: - $ref: '#/components/schemas/Route' - type: array - routes_v6: - description: 'The route v6 details. - - ' - items: - $ref: '#/components/schemas/Ipv6Route' - type: array - secondary_ipv4_addresses: - description: 'The secondary IPv4 addresses. - - ' + switch_state: + $ref: '#/components/schemas/SwitchState' + description: Switch State + required: + - site_id + ElementV2N1: + 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: Secondary Ipv4 Addresses + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string type: array - service_link: - $ref: '#/components/schemas/ServiceLink' - description: 'The service link details ServiceLink. - - ' - stp_state: - $ref: '#/components/schemas/STPStateS' - description: 'The STP state details. - - ' - svi_state: - $ref: '#/components/schemas/SVIStateS' - description: 'The svi details. + cluster_insertion_mode: + description: "The cluster insertion mode. \n" + type: string + cluster_member_id: + description: 'The cluster member ID. ' - vrf: - $ref: '#/components/schemas/VRF' - description: "The VRF details. \n" - InterfaceV4N16: - properties: - admin_up: - description: 'The interface admin state. + type: string + connected: + description: 'The device is connected. True or False. ' type: boolean - attached_lan_networks: - description: 'The attached lan network ID and vlan ID. - - ' - items: - $ref: '#/components/schemas/LanNetworkVlanMapping' - type: array - authentication_config: - $ref: '#/components/schemas/AuthenticationInterfaceConfig' - description: 'The authentication config details. - - ' - bound_interfaces: - description: 'The bound interfaces. - - ' - items: - description: Bound Interfaces - type: string - type: array - bypass_pair: - $ref: '#/components/schemas/BypassPairV2' - description: 'The details of the bypass pair. - - ' - cellular_config: - $ref: '#/components/schemas/CellularInterfaceConfig' - description: 'The cellular config details. + 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 interface description. Max size = 256. - - ' - devicemgmt_policysetstack_id: - description: 'The device management policy set stack ID. + description: 'The description of the element. ' + hw_id: + description: "The hardware ID. \n" type: string - dhcp_relay: - $ref: '#/components/schemas/DHCPRelay' - description: 'The DHCP relay information. + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: 'The L3 direct private WAN is enabled. True or False. ' - directed_broadcast: - description: 'The directed broadcast. + type: boolean + 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 - ethernet_port: - $ref: '#/components/schemas/EthernetPort' - description: 'The ethernet port information. + model_name: + description: "The model name of the device. \n" + type: string + name: + description: 'The name of the device. ' - id: - description: 'The interface ID. + type: string + network_policysetstack_id: + description: 'The network policy stack ID. ' type: string - interface_profile_id: - description: 'The interface profile ID. + priority_policysetstack_id: + description: 'The priority policy set stack ID. ' type: string - ipfixcollectorcontext_id: - description: 'The IPFIX collector context ID. + role: + description: 'The element role. ' + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - ipfixfiltercontext_id: - description: 'The IPFIX filter context ID. + serial_number: + description: 'The serial number. ' type: string - ipv4_config: - $ref: '#/components/schemas/Ipv4Config' - description: 'The ipv4 config information. + site_id: + description: 'The site ID. ' - ipv6_config: - $ref: '#/components/schemas/Ipv6ConfigV1' - description: 'The ipv6 config information. - - ' - lldp_enabled: - description: 'If LLDP enabled. True/False. - - ' - type: boolean - mac_address: - description: 'The interface configuration MAC address. - - ' - type: string - mtu: - description: 'The MTU value of the interface. - - ' - type: integer - multicast_config: - $ref: '#/components/schemas/MulticastInterfaceConfig' - description: 'The multicast config details. - - ' - name: - description: 'The name of the interface state. Max size = 128. + type: string + software_version: + description: 'The software version. ' type: string - nat_address: - description: 'The NAT IP address. + 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 - nat_address_v6: - description: 'The NAT IPV6 address. - - ' + required: + - site_id + ElementV2N2: + properties: + admin_action: + description: Admin Action + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID type: string - nat_pools: - description: 'The NAT pools information. - - ' + allowed_roles: + description: Allowed Roles items: - $ref: '#/components/schemas/NatPool' + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string type: array - nat_port: - description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part - of logical interface groups. - - ' - format: int32 - type: integer - nat_port_v6: - description: "The NAT IPv6 port.Internet bypass ports cannot be part of\ - \ logical interface groups. \n" - format: int32 - type: integer - nat_zone_id: - description: 'The NAT zone ID. - - ' - type: string - network_context_id: - description: 'The network context ID. - - ' + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - parent: - description: 'The parent value = true. - - ' + cluster_member_id: + description: Cluster Member Id type: string - peer_bypasspair_wan_port_type: - description: 'The peer bypass pair WAN port type. - - ' + connected: + description: Connected + type: boolean + deployment_op: + description: Deployment Op enum: - - none - - cellular + - 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 - poe_enabled: - description: 'PoE enabled = true/false. - - ' + description: + description: Description + type: string + hw_id: + description: Hw Id + type: string + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding type: boolean - power_usage_threshold: - description: 'The interface config PoE power usage threshold. Valid values - are in the range 50-100. - - ' - format: int32 - type: integer - pppoe_config: - $ref: '#/components/schemas/PppoEInterfaceConfig' - description: 'The PPPoE config information. - - ' - scope: - description: 'The network scope. - - ' + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + model_name: + description: Model Name + type: string + name: + description: Name + type: string + network_policysetstack_id: + description: Network Policysetstack Id + type: string + priority_policysetstack_id: + description: Priority Policysetstack Id + type: string + role: + description: Role enum: - - GLOBAL - - LOCAL + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + serial_number: + description: Serial Number + type: string + site_id: + description: Site Id + type: string + software_version: + description: Software Version + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV1' + description: Spoke Ha Config + 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 - secondary_ip_configs: - description: 'The interface secondary IP config. Secondary IPs exceed the - supported limit of 8. - - ' - items: - $ref: '#/components/schemas/SecondaryIPConfig' - type: array - service_link_config: - $ref: '#/components/schemas/ServiceLinkV2' - description: 'The interface secondary IP config. Secondary IPs exceed the - supported limit of 8. - - ' - site_wan_interface_ids: - description: 'The site WAN interface IDs. - - ' - items: - description: Site Wan Interface Ids - type: string - type: array - static_arp_configs: - description: 'The static ARP config details. - - ' - items: - $ref: '#/components/schemas/StaticARPConfig' - type: array - sub_interface: - $ref: '#/components/schemas/SubInterface' - description: 'The sub interface vlan ID. - - ' - switch_port_config: - $ref: '#/components/schemas/SwitchPortConfig' - description: 'The switch port config details. - - ' tags: - description: 'A information field that can be added to identify the interface. - Maximum 10 Unique tags of length 1024 each are allowed. - - ' + description: Tags items: description: Tags type: string type: array - type: - description: 'The interface type. - - ' - type: string - used_for: - description: 'The interface used for value. The allowed values are public,private_wan,lan,none. - - ' + ElementV2N3: + properties: + admin_action: + description: Admin Action + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID type: string - vlan_config: - $ref: '#/components/schemas/VlanConfig' - description: 'The VLAN config details. - - ' - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. - - ' + admin_renew_state: + description: Admin Renew State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - required: - - peer_bypasspair_wan_port_type - - scope - - used_for - - type - InterfaceV4N17: - properties: - admin_up: - description: 'The interface admin state. - - ' - type: boolean - attached_lan_networks: - description: 'The attached lan network ID and vlan ID. - - ' - items: - $ref: '#/components/schemas/LanNetworkVlanMapping' - type: array - authentication_config: - $ref: '#/components/schemas/AuthenticationInterfaceConfig' - description: 'The authentication config details. - - ' - bound_interfaces: - description: 'The bound interfaces. - - ' + allowed_roles: + description: Allowed Roles items: - description: Bound Interfaces + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string type: array - bypass_pair: - $ref: '#/components/schemas/BypassPairV2' - description: 'The details of the bypass pair. - - ' - cellular_config: - $ref: '#/components/schemas/CellularInterfaceConfig' - description: 'The cellular config details. - - ' - description: - description: 'The interface description. Max size = 256. - - ' - devicemgmt_policysetstack_id: - description: 'The device management policy set stack ID. - - ' + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - dhcp_relay: - $ref: '#/components/schemas/DHCPRelay' - description: 'The DHCP relay information. - - ' - directed_broadcast: - description: 'The directed broadcast. - - ' + cluster_member_id: + description: Cluster Member Id + type: string + connected: + description: Connected type: boolean - ethernet_port: - $ref: '#/components/schemas/EthernetPort' - description: 'The ethernet port information. - - ' - id: - description: 'The interface ID. - - ' + 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 - interface_profile_id: - description: 'The interface profile ID. - - ' + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string - ipfixcollectorcontext_id: - description: 'The IPFIX collector context ID. - - ' + hw_id: + description: Hw Id type: string - ipfixfiltercontext_id: - description: 'The IPFIX filter context ID. - - ' + id: + description: Id type: string - ipv4_config: - $ref: '#/components/schemas/Ipv4Config' - description: 'The ipv4 config information. - - ' - ipv6_config: - $ref: '#/components/schemas/Ipv6ConfigV1' - description: 'The ipv6 config information. - - ' - lldp_enabled: - description: 'If LLDP enabled. True/False. - - ' + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding type: boolean - mac_address: - description: 'The interface configuration MAC address. - - ' + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + model_name: + description: Model Name type: string - mtu: - description: 'The MTU value of the interface. - - ' - type: integer - multicast_config: - $ref: '#/components/schemas/MulticastInterfaceConfig' - description: 'The multicast config details. - - ' name: - description: 'The name of the interface state. Max size = 128. - - ' + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - nat_address: - description: 'The NAT IP address. - - ' + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string - nat_address_v6: - description: 'The NAT IPV6 address. - - ' + network_policysetstack_id: + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - nat_pools: - description: 'The NAT pools information. - - ' - items: - $ref: '#/components/schemas/NatPool' - type: array - nat_port: - description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part - of logical interface groups. - - ' - format: int32 - type: integer - nat_port_v6: - description: "The NAT IPv6 port.Internet bypass ports cannot be part of\ - \ logical interface groups. \n" - format: int32 - type: integer - nat_zone_id: - description: 'The NAT zone ID. - - ' + priority_policysetstack_id: + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string - network_context_id: - description: 'The network context ID. - - ' + role: + description: Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - parent: - description: 'The parent value = true. - - ' + serial_number: + description: Serial Number type: string - peer_bypasspair_wan_port_type: - description: 'The peer bypass pair WAN port type. - - ' - enum: - - none - - cellular + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' type: string - poe_enabled: - description: 'PoE enabled = true/false. - - ' - type: boolean - power_usage_threshold: - description: 'The interface config PoE power usage threshold. Valid values - are in the range 50-100. - - ' - format: int32 - type: integer - pppoe_config: - $ref: '#/components/schemas/PppoEInterfaceConfig' - description: 'The PPPoE config information. - - ' - scope: - description: 'The network scope. - - ' + software_version: + description: Software Version + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV1' + description: 'Spoke Ha Config: Valid ' + state: + description: State enum: - - GLOBAL - - LOCAL + - 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 - secondary_ip_configs: - description: 'The interface secondary IP config. Secondary IPs exceed the - supported limit of 8. - - ' - items: - $ref: '#/components/schemas/SecondaryIPConfig' - type: array - service_link_config: - $ref: '#/components/schemas/ServiceLinkV2' - description: 'The interface secondary IP config. Secondary IPs exceed the - supported limit of 8. - - ' - site_wan_interface_ids: - description: 'The site WAN interface IDs. - - ' - items: - description: Site Wan Interface Ids - type: string - type: array - static_arp_configs: - description: 'The static ARP config details. - - ' - items: - $ref: '#/components/schemas/StaticARPConfig' - type: array - sub_interface: - $ref: '#/components/schemas/SubInterface' - description: 'The sub interface vlan ID. - - ' - switch_port_config: - $ref: '#/components/schemas/SwitchPortConfig' - description: 'The switch port config details. - - ' tags: - description: 'A information field that can be added to identify the interface. - Maximum 10 Unique tags of length 1024 each are allowed. - - ' + 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) ' items: description: Tags type: string type: array - type: - description: 'The interface type. - - ' - type: string - used_for: - description: 'The interface used for value. The allowed values are public,private_wan,lan,none. - - ' - type: string - vlan_config: - $ref: '#/components/schemas/VlanConfig' - 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 - InventoryOperation: - enum: - - claim - - return - - revoke - - reuse - - retire - - recover - - remanufacture - - default - - invalid - - esp_allocate - - esp_received_stock - - esp_return - - esp_revoke - - esp_reuse - type: string - Ipv4Config: - properties: - dhcp_config: - $ref: '#/components/schemas/Ipv4Dhcp' - description: 'The DHCP config information. - - ' - dns_v4_config: - $ref: '#/components/schemas/DNS' - description: 'The DNS v4 config details. - - ' - pppoe_config: - $ref: '#/components/schemas/Ipv4Pppoe' - description: 'The PPoE config information. - - ' - routes: - description: 'The ethernet port routes. - - ' - items: - $ref: '#/components/schemas/Route' - type: array - static_config: - $ref: '#/components/schemas/Ipv4Static' - description: 'The IPv4 static address. - - ' - type: - description: 'The interface config type. Max = 12. - - ' - type: string - Ipv4Dhcp: - properties: - client_id: - description: 'The client ID. - - ' - type: string - hostname: - description: 'The IPv4 DHCP host name. - - ' - type: string - Ipv4Pppoe: - properties: - chap_passwd: - description: 'The PPPoE IPv4 CHAP password. - - ' - type: string - chap_user: - description: 'The PPPoE IPv4 CHAP user. - - ' - type: string - set_route: - description: "The set route for PPPoE IPv4. \n" + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding type: boolean - Ipv4Static: + required: + - site_id + ElementV2N4: properties: - address: - description: Address + admin_action: + description: Admin Action + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID type: string - Ipv6ConfigV1: - properties: - dhcp_config: - $ref: '#/components/schemas/Ipv6Dhcp' - description: "The DHCP config information. \n" - dns_v6_config: - $ref: '#/components/schemas/DNS' - description: 'The DNS V6 configurations. - - ' - routes: - description: 'The route details. - - ' - items: - $ref: '#/components/schemas/Route' - type: array - static_config: - $ref: '#/components/schemas/Ipv6StaticV1' - description: 'The IPv6 static address. - - ' - type: - description: 'The interface config type. Max = 12. - - ' - type: string - Ipv6Dhcp: - properties: - client_id: - description: 'The client ID. - - ' - type: string - hostname: - description: 'The IPv6 DHCP host name. - - ' - type: string - Ipv6Route: - properties: - destination: - description: 'The route destination. - - ' - type: string - via: - description: 'The via IPv6 address. - - ' - type: string - Ipv6StaticV1: - properties: - address: - description: 'The IPv6 static address. - - ' - type: string - enable_prefix_distribution: - description: 'Is prefix distribution enabled. True or False. - - ' - type: boolean - LanNetworkVlanMapping: - properties: - lan_network_id: - description: 'The LAN network ID. - - ' + admin_renew_state: + description: Admin Renew State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - vlan_id: - description: 'The VLAN ID. VLAN ID should be between 0 and 4095. - - ' - format: int32 - type: integer - LedConfig: - properties: - service_led_on: - description: Service Led On - type: boolean - 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. - - ' + allowed_roles: + description: Allowed Roles items: + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN 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 - 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. - - ' + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - proxy_id: - description: 'The proxy ID. - - ' + cluster_member_id: + description: Cluster Member Id type: string - Machine: - properties: connected: - description: "The device is connected. True or False. \n" + description: Connected type: boolean - console_conf_passphrase: - description: "The console password. \n" + 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 - em_element_id: - description: "The element ID. \n" + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string hw_id: - description: 'The hardware ID. - - ' + description: Hw Id type: string id: description: Id type: string - image_version: - description: 'The image version. - - ' + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + model_name: + description: Model Name type: string - inventory_op: - description: 'The inventory lifecycle values. - - ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + 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.) ' + 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) ' + 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) ' + type: string + role: + description: Role 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: - 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. - - ' + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - model_name: - description: "The model name of the device. \n" + serial_number: + description: Serial Number type: string - ordering_info: - description: "The order information. \n" + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' type: string - pki_op: - $ref: '#/components/schemas/CAStoreOperation' - description: Pki Op - renew_state: - 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 + software_version: + description: Software Version type: string - ship_state: - description: 'The shipping status. - - ' + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + state: + description: State enum: - - MACHINE_SHIPPED - - MACHINE_SHIPPED_CORRECT_ADDRESS - - MACHINE_SHIPPED_WRONG_ADDRESS - - MACHINE_NOT_SHIPPED - type: string - sl_no: - description: 'The serial number. - - ' - type: string - token: - description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. - - ' + - 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 + 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) ' + items: + description: Tags + type: string + type: array + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding + type: boolean required: - - ship_state - - manufacture_id - - renew_state - - machine_state - - image_version - - model_name - - sl_no - - hw_id - MachineInfoV2N3: + - site_id + ElementV2N5: properties: - connected: - description: "The device is connected. True or False. \n" - type: boolean - console_conf_passphrase: - description: "The console password. \n" - type: string - em_element_id: - description: "The element ID. \n" - type: string - esp_tenant_id: - description: 'The MSP tenant ID. - - ' - type: string - hw_id: - description: 'The hardware ID. - - ' - type: string - id: - type: string - image_version: - description: 'The image version. - - ' + admin_action: + description: Admin Action + enum: + - ALLOCATE + - CLAIM + - BOUND + - UNBOUND + - DECLAIM + - RETURN + - REVOKE + - RETIRE + - STOCK + - UPGRADE + - REMANUFACTURE + - DEFAULT + - INVALID type: string - inventory_op: - $ref: '#/components/schemas/InventoryOperation' - description: 'The inventory lifecycle values. - - ' - machine_state: - $ref: '#/components/schemas/MachineState' - description: 'The various device states. - - ' - manufacture_id: - description: 'The manufacture ID. - - ' + admin_renew_state: + description: Admin Renew State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - model_name: - description: "The model name of the device. \n" + admin_suspend_state: + description: Admin Suspend State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - ordering_info: - description: "The order information. \n" + allowed_roles: + description: Allowed Roles + items: + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + type: array + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - owner_tenant_id: - description: "The owner tenant ID. \n" + cluster_member_id: + description: Cluster Member Id type: string - pki_op: - $ref: '#/components/schemas/CAStoreOperation' - renew_state: - $ref: '#/components/schemas/MachineState' - description: 'The device renew states. - - ' - sales_order_number: - description: 'The sales order number. - - ' + 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 - ship_state: - $ref: '#/components/schemas/MachineShipState' - description: 'The shipping status. - - ' - sl_no: + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string - token: - description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. - - ' + fips_mode: + description: Fips Mode + enum: + - none + - fips + - non_fips type: string - type: object - MachineQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of machines that match the query parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 + fips_mode_change_start_time: + description: Fips Mode Change Start Time + format: int64 type: integer - getDeleted: - description: 'The number machines deleted for a time frame. - - ' - type: boolean - group_by: - description: 'Group the machines for the query. - - ' - items: - description: Group By - type: string - type: array + hw_id: + description: Hw Id + type: string id: - description: "List the machines by ID. \n" + description: 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: - 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. - - ' + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding 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 - MachineQueryFilterV2N3: - properties: - connected: - description: "The device is connected. True or False. \n" + l3_lan_forwarding: + description: L3 Lan Forwarding type: boolean - console_conf_passphrase: - description: "The console password. \n" + model_name: + description: Model Name type: string - em_element_id: - description: "The element ID. \n" + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - esp_tenant_id: - description: 'The MSP tenant ID. - - ' + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' type: string - hw_id: - description: 'The hardware ID. - - ' + network_policysetstack_id: + description: 'Network Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy + set stack id) ' type: string - id: - description: Id + priority_policysetstack_id: + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' type: string - image_version: - description: 'The image version. - - ' + role: + description: Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - inventory_op: - description: 'The inventory lifecycle values. - - ' + 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_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + 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 + 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) ' + items: + description: Tags + type: string + type: array + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding + type: boolean + required: + - site_id + ElementV2N6: + properties: + admin_action: + description: Admin Action enum: + - ALLOCATE - CLAIM + - BOUND + - UNBOUND + - DECLAIM - RETURN - REVOKE - - REUSE - RETIRE - - RECOVER + - STOCK + - UPGRADE - REMANUFACTURE - DEFAULT - INVALID - - ALLOCATE - - RECEIVED_STOCK - - ESP_ALLOCATE - - ESP_RECEIVED_STOCK - - ESP_RETURN - - ESP_REVOKE - - ESP_REUSE - type: string - machine_state: - 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. - - The manufacture ID. - - ' - type: string - model_name: - description: "The model name of the device. \n" - type: string - ordering_info: - description: "The order information. \n" type: string - owner_tenant_id: - description: "The owner tenant ID. \n" - type: string - pki_op: - $ref: '#/components/schemas/CAStoreOperation' - description: Pki Op - renew_state: - description: 'The device renew states. - - ' + admin_renew_state: + description: Admin Renew State 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 - sales_order_number: - description: 'The sales order number. - - ' + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - ship_state: - description: 'The shipping status. - - ' + admin_suspend_state: + description: Admin Suspend State enum: - - MACHINE_SHIPPED - - MACHINE_SHIPPED_CORRECT_ADDRESS - - MACHINE_SHIPPED_WRONG_ADDRESS - - MACHINE_NOT_SHIPPED - type: string - sl_no: - description: Sl No + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - suspend_state: - description: 'The suspend state. - - ' - 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 + allowed_roles: + description: Allowed Roles + items: + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + type: array + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - token: - description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. - - ' + cluster_member_id: + description: Cluster Member Id type: string - MachineQueryFilterV2N5: - properties: connected: - description: "The device is connected. True or False. \n" + description: Connected type: boolean - console_conf_passphrase: - description: "The console password. \n" + 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 - element_shell_id: - description: "The element shell ID. \n" + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string - em_element_id: - description: 'The element ID. - - ' + device_profile_id: + description: Device Profile Id type: string - esp_tenant_id: - description: 'The MSP tenant ID. - - ' + fips_mode: + description: Fips Mode + enum: + - none + - fips + - non_fips type: string + fips_mode_change_start_time: + description: Fips Mode Change Start Time + format: int64 + type: integer hw_id: - description: 'The hardware ID. - - ' + description: Hw Id type: string id: description: Id type: string - image_version: - description: 'The image version. - - ' + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + 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) ' + format: int32 + type: integer + model_name: + description: Model Name type: string - inventory_op: - description: 'The inventory lifecycle values. - - ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + 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.) ' + 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) ' + type: string + override_indicator: + description: Override Indicator + items: + description: Override Indicator + type: string + type: array + priority_policysetstack_id: + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' + type: string + role: + description: Role + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + 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_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + 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 + switch_config: + $ref: '#/components/schemas/SwitchConfig' + description: 'Switch Config: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding + type: boolean + required: + - site_id + ElementV2N7: + properties: + admin_action: + description: Admin Action enum: + - ALLOCATE - CLAIM + - BOUND + - UNBOUND + - DECLAIM - RETURN - REVOKE - - REUSE - RETIRE - - RECOVER + - STOCK + - UPGRADE - REMANUFACTURE - DEFAULT - INVALID - - ALLOCATE - - RECEIVED_STOCK - - ESP_ALLOCATE - - ESP_RECEIVED_STOCK - - ESP_RETURN - - ESP_REVOKE - - ESP_REUSE type: string - is_eval: - description: 'Is Eval: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' + admin_renew_state: + description: Admin Renew State + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - machine_state: - description: 'The various device states. - - ' + admin_suspend_state: + description: Admin Suspend State 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 + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - manufacture_id: - description: 'The manufacture ID. - - ' + allowed_roles: + description: Allowed Roles + items: + description: Allowed Roles + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN + type: string + type: array + cluster_insertion_mode: + description: Cluster Insertion Mode type: string - model_name: - description: "The model name of the device. \n" + cluster_member_id: + description: Cluster Member Id type: string - ordering_info: - description: "The order information. \n" + 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 - owner_tenant_id: - description: "The owner tenant ID. \n" + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string - pki_op: - $ref: '#/components/schemas/CAStoreOperation' - description: Pki Op - renew_state: - description: 'The device renew states. - - ' + device_profile_id: + description: Device Profile Id + type: string + fips_mode: + description: Fips Mode 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 + - none + - fips + - non_fips type: string - sales_order_number: - description: 'The sales order number. - - ' + fips_mode_change_start_time: + description: Fips Mode Change Start Time + format: int64 + type: integer + hw_id: + description: Hw Id type: string - ship_state: - description: 'The shipping status. - - ' + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: L3 Direct Private Wan Forwarding + type: boolean + l3_lan_forwarding: + description: L3 Lan Forwarding + type: boolean + led_config: + $ref: '#/components/schemas/LedConfig' + description: 'Led Config: Valid ' + 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) ' + format: int32 + type: integer + model_name: + description: Model Name + type: string + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + 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.) ' + 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) ' + type: string + override_indicator: + description: Override Indicator + items: + description: Override Indicator + type: string + type: array + priority_policysetstack_id: + description: 'Priority Policysetstack Id: Digits(fraction = 0, integer = + 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy + set stack id) ' + type: string + role: + description: Role enum: - - MACHINE_SHIPPED - - MACHINE_SHIPPED_CORRECT_ADDRESS - - MACHINE_SHIPPED_WRONG_ADDRESS - - MACHINE_NOT_SHIPPED + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - sl_no: - description: Sl No + serial_number: + description: Serial Number type: string - suspend_state: - description: 'The suspend state. - - ' + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string + software_version: + description: Software Version + type: string + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'Spoke Ha Config: Valid ' + state: + description: State 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 - token: - description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. - - ' - type: string - MachineShipState: - enum: - - machine_shipped - - machine_shipped_correct_address - - machine_shipped_wrong_address - - machine_not_shipped - type: string - MachineState: - enum: - - manufactured - - manufactured_qa_pending - - manufactured_qa_ok - - manufactured_qa_not_ok - - manufactured_battery_test_pending - - manufactured_battery_test_start - - manufactured_battery_test_passed - - 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 - - allocated - - allocated_to_esp - - claim_pending - - initializing - - initialization_failed - - assigned - - claim_pending - - claimed - - claim_failed - - to_be_returned - - returned - - revoked - - machine_element_delete_pending - - return_failed - - received_stock - - remanufactured - - retired - - recover - - 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 - type: string - MachineSystemStatusV2N1: - properties: - boot_mode: - description: "The possible values in the boot mode. \n" - enum: - - BIOS - - UEFI_ONLY - - UEFI_SECURE + - 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 - disk_status: - description: "The status details of the disk. \n" + switch_config: + $ref: '#/components/schemas/SwitchConfig' + description: 'Switch Config: Valid ' + 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) ' items: - $ref: '#/components/schemas/DiskPartitionStatus' + description: Tags + type: string type: array - fips_mode: - description: "The possible values in the FIPs. \n" - enum: - - none - - fips - - non_fips - type: string - hardware_id: - description: "The machine hardware ID. \n" - type: string - id: - description: 'The machine ID. - - ' - type: string - tpm_status: - description: 'The TPM status. - - ' - type: string - trusted_boot: - description: 'The possible values in trusted boot. - - ' - enum: - - PASSED - - FAILED - type: string + vpn_to_vpn_forwarding: + description: Vpn To Vpn Forwarding + type: boolean required: - - hardware_id - MachineV2N3: + - site_id + ElementV3: properties: - connected: - description: "The device is connected. True or False. \n" - type: boolean - console_conf_passphrase: - description: "The console password. \n" - type: string - em_element_id: - description: "The element ID. \n" - type: string - esp_tenant_id: - description: 'The MSP tenant ID. - - ' - type: string - hw_id: - description: 'The hardware ID. - - ' - type: string - id: - description: Id - type: string - image_version: - description: 'The image version. - - ' - type: string - inventory_op: - description: 'The inventory lifecycle values. + admin_action: + description: 'The values of admin actions that can be performed. ' enum: + - ALLOCATE - CLAIM + - BOUND + - UNBOUND + - DECLAIM - RETURN - REVOKE - - REUSE - RETIRE - - RECOVER + - STOCK + - UPGRADE - REMANUFACTURE - DEFAULT - INVALID - - ALLOCATE - - RECEIVED_STOCK - - ESP_ALLOCATE - - ESP_RECEIVED_STOCK - - ESP_RETURN - - ESP_REVOKE - - ESP_REUSE type: string - machine_state: - description: 'The various device states. + admin_renew_state: + description: 'The values of admin renew state. ' 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 + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION type: string - manufacture_id: - description: 'The manufacture ID. + admin_suspend_state: + description: "The values of the admin suspend state. \n" + enum: + - SLEEP + - INIT + - ACTIVE + - ACTIVE_ASSIGNED_DEFAULT + - ACTIVE_ASSIGNED_TENANT + - ACTIVE_TRUSTED + - ACTIVE_NOCERT + - ACTIVE_CLAIMED + - ACTIVE_MIC + - ACTIVE_MIC_PENDING + - ACTIVE_MIC_ISSUED + - ACTIVE_MIC_FAILED + - ACTIVE_CIC + - ACTIVE_CIC_SITE + - ACTIVE_CIC_PENDING + - ACTIVE_CIC_ISSUED + - ACTIVE_CIC_FAILED + - ACTIVE_INVENTORY_IN_PROGRESS + - ACTIVE_INVENTORY_GET_PENDING + - ACTIVE_INVENTORY_POST_PENDING + - ACTIVE_INVENTORY_GET_COMPLETE + - ACTIVE_INVENTORY_GET_FAILED + - ACTIVE_INVENTORY_OPERATION_FAILED + - ACTIVE_INTF_CONFIG_GET_PENDING + - ACTIVE_INTF_CONFIG_GET_COMPLETE + - ACTIVE_INTF_CONFIG_GET_FAILED + - ACTIVE_INTF_STATE_GET_PENDING + - ACTIVE_INTF_STATE_GET_COMPLETE + - ACTIVE_INTF_STATE_GET_FAILED + - ACTIVE_BOUND_TO_SITE_PENDING + - ACTIVE_BOUND_TO_SITE + - ACTIVE_BOUND_TO_SITE_FAILED + - ACTIVE_READY + - ACTIVE_RENEW_PENDING + - ACTIVE_RENEWED + - ACTIVE_DECLAIM_IN_PROGRESS + - ACTIVE_DECLAIMED + - ACTIVE_UNBOUND_FROM_SITE + - ACTIVE_UNBOUND_IN_PROGRESS + - ACTIVE_UNBOUND_FROM_SITE_FAILED + - ACTIVE_CIC_CERTIFICATE_CHECK + - ACTIVE_MONITORING + - ACTIVE_CONNECTED + - ACTIVE_24_HOURS_LESS + - ACTIVE_24_HOURS_MORE + - ACTIVE_TROUBLESHOOT + - ACTIVE_SUSPEND_INIT + - ACTIVE_SUSPEND_IN_PROGRESS + - ACTIVE_SUSPENDED + - ACTIVE_SUSPEND_FAILED + - ACTIVE_SUSPEND_FAILED_TIMEOUT + - ACTIVE_SUSPENDED_MIC_OPERATIONAL + - ACTIVE_SUSPENDED_CIC_OPERATIONAL + - ACTIVE_SUSPENDED_EMPTY_TOKEN + - ACTIVE_SUSPENDED_TOKEN_EXPIRED + - INACTIVE_NOCERT + - INACTIVE_MIC + - INACTIVE_CIC + - INACTIVE_CIC_SITE + - RETURNED + - STANDBY + - OOS_AT_READY + - OOS_AT_INIT + - OOS_AT_BIND_PENDING + - OOS_AT_BIND + - OOS_AT_BIND_FAILED + - OOS_AT_UNBIND_FAILED + - OOS_AT_UNBIND_PROGRESS + - DECOMMISSION + 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_id: + description: Cluster Id + type: string + connected: + description: 'The element 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 - model_name: - description: "The model name of the device. \n" + description: + description: 'The description of the element. + + ' + device_profile_id: + description: 'The device profile ID. + + ' type: string - ordering_info: - description: "The order information. \n" + fips_mode: + description: 'The FIPs mode. + + ' + enum: + - none + - fips + - non_fips type: string - owner_tenant_id: - description: "The owner tenant ID. \n" + fips_mode_change_start_time: + description: 'The FIPs mode change starting time. + + ' + format: int64 + type: integer + hw_id: + description: 'The hardware ID. + + ' type: string - pki_op: - $ref: '#/components/schemas/CAStoreOperation' - description: Pki Op - renew_state: - description: 'The device renew states. + id: + description: Id + type: string + l3_direct_private_wan_forwarding: + description: 'The L3 direct private WAN is enabled. True or False. ' - 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 - sales_order_number: - description: 'The sales order number. + type: boolean + 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: string - ship_state: - description: 'The shipping status. + type: boolean + led_config: + $ref: '#/components/schemas/LedConfig' + description: 'Valid LED config. ' - enum: - - MACHINE_SHIPPED - - MACHINE_SHIPPED_CORRECT_ADDRESS - - MACHINE_SHIPPED_WRONG_ADDRESS - - MACHINE_NOT_SHIPPED + main_power_usage_threshold: + description: "The main power usage threshold. Allowed range is 50-100. \ + \ \n" + format: int32 + type: integer + model_name: + description: "The model name of the device. \n" type: string - sl_no: - description: 'The serial number. + name: + description: 'The name of the device. ' type: string - suspend_state: - description: 'The suspend state. + nat_policysetstack_id: + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. ' - 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 - token: - description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. + network_policysetstack_id: + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. ' type: string - 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. + override_indicator: + description: 'The override indicator. + + ' + items: + description: Override Indicator + type: string + type: array + priority_policysetstack_id: + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. ' type: string - element_shell_id: - description: "The element shell ID. \n" - type: string - em_element_id: - description: "The element ID. \n" - type: string - esp_tenant_id: - description: 'The MSP tenant ID. + role: + description: 'The element role. ' + enum: + - NONE + - HUB + - SPOKE + - PA_WE_BR + - PA_WE_DC + - PA_CONN type: string - hw_id: - description: 'The hardware ID. + serial_number: + description: 'The serial number. ' type: string - id: - description: Id + site_id: + description: 'The site ID. + + ' type: string - image_version: - description: 'The image version. + software_version: + description: 'The software version. ' type: string - inventory_op: - description: 'The inventory lifecycle values. + spoke_ha_config: + $ref: '#/components/schemas/SpokeHAConfigV2' + description: 'The details of the spoke HA configuration. + + ' + state: + description: 'The element state. ' 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 - is_eval: - description: 'Is Eval: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], - value = ALWAYS, valueFilter = classOf[Void]) ' + - 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 - machine_state: - description: 'The various device states. + switch_config: + $ref: '#/components/schemas/SwitchConfig' + description: 'The details of the switch configuration. ' - 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. + tags: + description: 'A information field that can be added to identify the element. ' - type: string - model_name: - description: "The model name of the device. \n" - type: string - ordering_info: - description: "The order information. \n" - type: string - owner_tenant_id: - description: "The owner tenant ID. \n" - type: string - pki_op: - $ref: '#/components/schemas/CAStoreOperation' - description: Pki Op - renew_state: - description: 'The device renew states. + items: + description: Tags + type: string + type: array + vpn_to_vpn_forwarding: + description: 'VPN to VPN forwarding. True or False. ' - 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 - sales_order_number: - description: 'The sales order number. + type: boolean + required: + - site_id + Error: + properties: + _error: + items: + $ref: '#/components/schemas/ErrorResponse' + type: array + ErrorResponse: + properties: + code: + description: 'The error code. ' type: string - ship_state: - description: 'The shipping status. + message: + description: 'The error message. ' - enum: - - MACHINE_SHIPPED - - MACHINE_SHIPPED_CORRECT_ADDRESS - - MACHINE_SHIPPED_WRONG_ADDRESS - - MACHINE_NOT_SHIPPED type: string - sl_no: - description: Sl No + Ethernet: + properties: + connector: + description: "The ethernet connector type. \n" type: string - suspend_state: - description: 'The suspend state. + device: + description: "The device name. \n" + type: string + disabled: + description: 'Disable the port. + + ' + type: boolean + disabled_reason: + description: 'Reason to disable the port. ' - 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 - token: - description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. + element_id: + description: 'Element ID. ' type: string - MulticastInterfaceConfig: - properties: - igmp_version: - description: 'The IGMP version. + id: + description: 'The connector ID. ' - enum: - - IGMPV2 - - IGMPV3 type: string - multicast_enabled: - description: 'Is multicast enabled. True or False. + inactive: + description: 'Port status (active or inactive). ' type: boolean - NatPool: - properties: - ipv4_ranges: - description: 'The NAT Ipv4 address ranges. Minimum 1 and maximum 4 nat pool - IP ranges can be specified. - - ' - items: - $ref: '#/components/schemas/IPv4Range' - type: array - nat_pool_id: - description: 'The NAT pool ID. + inactive_reason: + description: 'Reason for port being inactive. ' 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. + max_mtu: + description: 'The MTU max value. ' - type: boolean - PeerInfo: - properties: - hostname: - description: 'The peer hostname. + type: integer + max_speed: + description: 'The max speed value. ' - type: string - ip_addresses: - description: 'The peer IP addresses. Max size = 4. + type: integer + name: + description: 'The name. ' - items: - description: Ip Addresses - type: string - type: array - PoeStateS: - properties: - detection_status: - description: 'The PoE detection status. + type: string + original_mac_address: + description: 'The MAC address. ' type: string - device_type: - description: 'The ION device type. + region: + description: 'The region. ' type: string - operational_state: - description: "The PoE operational state. \n" - type: string - poe_enabled: - description: "Indicates if PoE is enabled. By default, PoE is disabled.\ - \ \n" - type: boolean - power_classification: - description: "The power classification. \n" - type: string - power_consumed: - description: 'The power consumed. + site_id: + description: 'The site ID. ' - format: float - type: number - power_pairs_control_ability: - description: 'Values = True or False. + type: string + required: + - site_id + EthernetPort: + properties: + full_duplex: + description: 'Interface running in full duplex mode. ' type: boolean - power_pairs_state: - description: 'The power pair state. + port_id: + $ref: '#/components/schemas/Ethernet' + description: 'The ethernet port ID. ' - type: string - power_priority: - description: 'The power priority. + port_name: + description: 'The ethernet port name. ' type: string - power_usage_threshold: - description: 'The Port Power Usage Alarm Threshold value is between 50 - - 100%.The default threshold is 100% (60W). - - ' + speed: + description: "The ethernet port speed. \n" format: int32 type: integer - Port: + Extension: properties: - end: - description: 'The end port range must be between 1 and 65535. + conf: + type: object + disabled: + description: 'List the disabled extensions. ' - type: string - start: - description: 'The start port range must be between 1 and 65535. + type: boolean + entity_id: + description: 'The entity ID. Only numbers are allowed (0-9). ' type: string - PppoEInterfaceConfig: - properties: - host_uniq: - description: 'The host. + id: + description: 'The ID. ' type: string - ip_address_type: - description: 'IPv4 and IPv6 addresses. - - ' + name: + description: "The name of the extension. Max size = 128. \n" type: string - password: - description: 'The password for the PPOE interface configuration. - - ' + namespace: + description: "The extension namespace. Values = ^[a-z][a-z0-9/]*[a-z0-9]+$\ + \ \n" type: string - reconnection_delay: - description: 'The recoonection delay value. - - ' + required: + - conf + - namespace + - name + ExtensionQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: Aggregate + dest_page: + description: Dest Page format: int32 type: integer - service_name: - description: 'The name of the service used for the PPPoE configuration. - - ' - type: string - username: - description: 'The username for the PPPoE interface configuration. + getDeleted: + description: GetDeleted + type: boolean + group_by: + description: Group By + items: + description: Group By + type: string + type: array + id: + description: 'The ID. ' type: string - Proxy: - properties: - local: - description: Local - type: string - local_port: - description: Local Port + last_query_ts: + description: Last Query Ts + format: int64 type: integer - protocol: - description: Protocol - type: string - protocol_number: - description: Protocol Number + limit: + description: Limit + format: int32 type: integer - proxy_id: - description: Proxy Id - type: string - remote: - description: Remote - type: string - remote_port: - description: Remote Port + 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 - RecoveryToken: + ExtensionQueryFilter: properties: - hardware_id: - description: Hardware Id - type: string + conf: + type: object + disabled: + description: 'List the disabled extensions. + + ' + type: boolean id: - description: Id + description: 'The ID. + + ' type: string - ion_token: - description: Ion Token + name: + description: "The name of the extension. Max size = 128. \n" type: string - is_used: - description: Is Used - type: boolean - secret_token: - description: Secret Token + namespace: + description: "The extension namespace. Values = ^[a-z][a-z0-9/]*[a-z0-9]+$\ + \ \n" type: string - token_validity_in_hour: - description: Token Validity In Hour - format: int32 - type: integer - valid_till_secs: - description: Valid Till Secs - format: int64 - type: integer - RecoveryTokenScreen: + required: + - conf + - namespace + - name + ExtensionScreen: properties: - id: - description: 'The recovery token ID. + conf: + type: object + disabled: + description: 'List the disabled extensions. ' - type: string - token_validity_in_hour: - description: 'The token validity in a hour. + type: boolean + entity_id: + description: 'The entity ID. Only numbers are allowed (0-9). ' - format: int32 - type: integer - Route: - properties: - destination: - description: 'The route destination. + type: string + id: + description: 'The ID. ' type: string - via: - description: 'The via IP address. + name: + 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]+$. ' type: string - STPStateS: - properties: - bpdu_guard_enabled: - description: 'BPDU Guard enabled on ports do not receive a BPDU from its - connected devices. When a BPDU Guard enabled port receives BPDU from a - connected device, BPDU Guard disables the port. + required: + - conf + - namespace + - name + GREConfig: + properties: + csum: + description: 'The CSUM. ' type: boolean - forward_fast_enabled: - description: 'The speed. + keepalive_enable: + description: 'Is keepalive enabled. True or False. ' type: boolean - mstp_instance_id: - description: "The MSTP instance ID. \n" - format: int32 - type: integer - port_cost: - description: "The STP port cost is between 1-65535. The STP port cost depends\ - \ on the speed of the port. \n" + 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 - port_priority: - description: "The STP Port priority is between 0-240. The default value\ - \ is 128, STP port priority is in multiples of 16. \n" + 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 - port_state: - description: 'The port state. + HardwareBypass: + properties: + element_bypass: + description: "The information on the element bypass pair. \n" + items: + $ref: '#/components/schemas/BypassInfo' + type: array + id: + description: 'The ID. ' type: string - root_guard_enabled: - description: 'Root Guard is enabled on a port-by-port basis, it prevents - a configured port from becoming a root port. Root Guard prevents a downstream - switch from becoming a root bridge in a topology. - - ' - type: boolean - stp_enabled: - description: 'Spanning Tree Protocol (STP) is enabled by default. By default, - the STP type is RSTP. + IKEV1Params: + properties: + xauth_id: + description: 'The xauth ID. ' - type: boolean - SVIStateS: - properties: - stp_designated_cost: - description: "The STP designated cost between 1-65535. \n" - type: integer - stp_designated_mac_address: - description: "The STP designated MAC address. \n" type: string - stp_designated_port: - description: "The STP designated port. \n" - type: integer - stp_designated_root_mac_address: - description: 'The STP designated root MAC address. + xauth_secret: + description: 'The authentication secret. Length must be between 4-128. ' 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: - description: Ipv4 Address - type: string - scope: - description: "The scope of the secondary IP config. \n" + xauth_secret_encrypted: + description: "The xauth secret. Value = True. \n" type: string - ServiceLink: - properties: - anti_replay: - description: 'The anti replay value. True or False. + xauth_secret_hash: + description: 'The xauth hash. Value = True. ' - type: boolean - anti_replay_window: - description: 'The anti replay window count. + type: string + xauth_type: + description: 'The xauth type. ' - type: integer - classic_site_id: - description: 'The site ID. + enum: + - NONE + - SECRET + type: string + required: + - xauth_type + IPSECAuthentication: + properties: + certificate: + description: 'The certificate authentication for the IPsec Profile. ' type: string - copy_tos: - description: Copy Tos - type: boolean - enable_gre_encapsulation: - description: 'Is GRE encapsulation enabled. True or False. + ikev1_params: + $ref: '#/components/schemas/IKEV1Params' + description: 'Ikev1 Params: Valid ' + local_ca_certificate: + description: "The local CA certificate uploaded for certificate authentication.\ + \ \n" + type: string + local_id: + description: 'The local ID type. ' - type: boolean - geneve_config: - $ref: '#/components/schemas/GeneveConfig' - description: 'Lists all the geneve configurations. + enum: + - LOCAL_IP + - DN + - HOSTNAME + - CUSTOM + type: string + local_id_custom: + description: 'The custom local ID. ' - gre_config: - $ref: '#/components/schemas/GREConfig' - description: 'The GRE config details. + type: string + passphrase: + description: Passphrase + type: string + passphrase_encrypted: + description: 'Passphrase Encrypted: JsonIgnore(value = true) ' + type: string + private_key: + description: 'The private key file uploaded for certificate authentication. ' - ipsec_config: - $ref: '#/components/schemas/IPSECConfig' - description: 'The IPSec config details. + type: string + private_key_encrypted: + description: 'Private Key Encrypted: JsonIgnore(value = true) ' + type: string + remote_ca_certificate: + description: "The standard VPN endpoint CA certificate uploaded. \ + \ \n" + type: string + remote_id: + description: "The ID for the standard VPN endpoint in the Remote ID field.\ + \ \n" + type: string + secret: + description: "The password for PSK authentication. \n" + type: string + secret_encrypted: + description: 'Secret Encrypted: JsonIgnore(value = true) ' + type: string + secret_hash: + description: 'Secret Hash: JsonIgnore(value = true) ' + type: string + type: + description: 'The authentication type = PSK or Certificates. ' - last_parent: - description: 'The last parent value = true. + enum: + - NONE + - PSK + - X509 + type: string + x509Objects: + $ref: '#/components/schemas/X509Objects' + description: 'X509Objects: JsonIgnore(value = true) ' + required: + - local_id + - type + IPSECConfig: + properties: + authentication: + $ref: '#/components/schemas/IPSECAuthentication' + description: 'The IPSec authentication details. ' - type: string - liveliness_probe: - $ref: '#/components/schemas/LivelinessProbe' - description: 'Lists the livliness probe details. + ipsec_profile_id: + description: 'The IPSec profile ID. ' - nat_traversal: - description: 'Nat traversal value. True or False. + type: string + required: + - ipsec_profile_id + IPv4Range: + properties: + end: + description: 'The end IPv4 address. ' - type: boolean - pa_location_oid: - description: Pa Location Oid type: string - pa_tunnel_oid: - description: Pa Tunnel Oid + start: + description: "The start IPv4 address. \n" type: string - parent: - description: 'The parent value = true. + required: + - end + - start + IPv6DNS: + properties: + name_servers: + description: 'The IPv6 configured DNS name servers. ' - type: string - passive_mode: - $ref: '#/components/schemas/PassiveMode' - description: 'Passive mode enabled on the device. True or False + items: + description: Name Servers + type: string + type: array + search: + description: 'The search parameters. ' - peer: - $ref: '#/components/schemas/PeerInfo' - description: 'The peer information. + items: + description: Search + type: string + type: array + InterfaceQueryResponseV4N10: + properties: + admin_up: + description: 'The interface admin state. ' - proxy_ids: - description: 'The proxy details. + type: boolean + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. ' items: - $ref: '#/components/schemas/Proxy' + $ref: '#/components/schemas/LanNetworkVlanMapping' type: array - sase_ike_gw_config: - $ref: '#/components/schemas/SaseIkeGWConfig' - description: 'The SASE IKE GW configurations. + bound_interfaces: + description: 'The bound interfaces. ' - security_service_endpoint_id: - description: 'The security service endpoint ID. + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: 'The details of the bypass pair. ' - type: string - service_endpoint_id: - description: 'The service endpoint ID. + description: + description: 'The interface description. Max size = 256. ' - type: string - tunnel_role: - description: "The tunnel role. \n" - type: string - type: - description: 'The service link type. + devicemgmt_policysetstack_id: + description: 'The device management policy set stack ID. ' - enum: - - IPSEC - - GRE - - GENEVE type: string - required: - - type - ServiceLinkV2: - properties: - gre_config: - $ref: '#/components/schemas/GREConfig' - description: 'The GRE config details. - - ' - ipsec_config: - $ref: '#/components/schemas/IPSECConfig' - description: 'The IPSec config details. + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. ' - last_parent: - description: 'The last parent value = true. + directed_broadcast: + description: 'The directed broadcast. ' - type: string - parent: - description: 'The parent value = true. + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. ' - type: string - peer: - $ref: '#/components/schemas/PeerInfo' - description: 'The peer information. + id: + description: 'The interface ID. ' - service_endpoint_id: - description: "The service endpoint ID. \n" type: string - type: - description: 'The service link type. + ipfixcollectorcontext_id: + description: 'The IPFIX collector context ID. ' - enum: - - IPSEC - - GRE - - GENEVE - type: string - required: - - type - Software: - properties: - location: - description: Location - type: string - version: - description: Version - type: string - SpokeHAConfigV2: - properties: - cluster_id: - description: "The spoke HA config cluster ID. \n" type: string - enable: - description: "The spoke HA config enabled. True or False. \n" - type: boolean - priority: - description: "The priority of the spoke HA config. \n" - format: int32 - type: integer - source_interface: - description: 'The spoke HA config source interface ID. + ipfixfiltercontext_id: + description: 'The IPFIX filter context ID. ' type: string - track: - $ref: '#/components/schemas/TrackV2' - description: 'Track: Valid ' - required: - - source_interface - - priority - - enable - - cluster_id - StaticARPConfig: - properties: - ipv4_address: - description: 'The static APR IPv4 address. + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. ' - type: string mac_address: - description: 'The MAC address. + description: 'The interface configuration MAC address. ' type: string - StormControlConfig: - properties: - broadcast_threshold: - description: 'By default, the broadcast threshold is set to 1000kbps. Enter - a value between 64 -1000000 kbps. - - ' - type: integer - multicast_threshold: - description: 'Multicast threshold value is set between 64-1000000kbps. + mtu: + description: 'The MTU value of the interface. ' type: integer - unicast_threshold: - description: 'Unknown Unicast threshold value is set between 64-1000000 - kbps. + name: + description: 'The name of the interface state. Max size = 128. ' - type: integer - SubInterface: - properties: - vlan_id: - description: Vlan Id - format: int32 - type: integer - SwitchConfig: - properties: - default_vlan_id: - description: 'Default VLAN ID is 1. + type: string + nat_address: + description: 'The NAT IP address. ' - format: int32 - type: integer - mstp_enabled: - description: 'The MSTP enabled. True or False. + type: string + nat_pools: + description: 'The NAT pools information. ' - type: boolean - stp_aging_timer: - description: "The STP aging Timer between 10 - 1000000 seconds. \ - \ \n" - format: int32 - type: integer - 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: "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: 'The length of Max Age time that the switch retains information - learned from BPDUs, set the value between 6 - 40 seconds. + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. ' format: int32 type: integer - stp_mode: - description: 'The STP Mode is RSTP, default STP mode is RSTP + nat_zone_id: + description: 'The NAT zone ID. ' - enum: - - RSTP type: string - stp_priority: - description: 'The Priority value is between 0 - 61440, in multiples of 4096. - - ' - format: int32 - type: integer - required: - - stp_mode - SwitchPortConfig: - properties: - access_vlan_id: - description: 'The VLAN access ID. + network_context_id: + description: 'The network context ID. ' - type: integer - bpdu_guard_enabled: - description: 'BPDU Guard enabled on ports do not receive a BPDU from its - connected devices. When a BPDU Guard enabled port receives BPDU from a - connected device, BPDU Guard disables the port. + type: string + parent: + description: 'The parent value = true. ' - type: boolean - forward_fast_enabled: - description: 'The speed. - - The attached lan network ID and vlan ID. + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'The PPPoE config information. ' - type: boolean - native_vlan_id: - description: 'The VLAN ID. + scope: + description: 'The network scope. ' - type: integer - root_guard_enabled: - description: 'Root Guard is enabled on a port-by-port basis, it prevents - a configured port from becoming a root port. Root Guard prevents a downstream - switch from becoming a root bridge in a topology. + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. ' - type: boolean - storm_control_config: - $ref: '#/components/schemas/StormControlConfig' - description: 'Storm control config information. Threshold for traffic rate - limit, the traffic is rate limited for the set threshold value. + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. ' - stp_port_cost: - description: 'STP port cost between 1-65535. The STP port cost depends on - the speed of the port. + site_wan_interface_ids: + description: 'The site WAN interface IDs. ' - format: int32 - type: integer - stp_port_enabled: - description: 'Spanning Tree Protocol (STP) port enabled. + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'The static ARP config details. ' - type: boolean - stp_port_priority: - description: 'STP Port priority is between 0-240. The default value is 128, - STP port priority is in multiples of 16. + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. ' - format: int32 - type: integer - trunk_vlans: - description: 'The interface config switch port trunk VLANs. Max trunk VLANs - allowed is 32 and no duplicates are allowed. + tags: + description: 'A information field that can be added to identify the interface. + Maximum 10 Unique tags of length 1024 each are allowed. ' items: - description: Trunk Vlans + description: Tags type: string type: array - vlan_mode: - description: 'The VLAN mode. + type: + description: 'The interface type. ' - enum: - - access - - trunk type: string - voice_vlan_id: - description: 'The voice VLAN ID. + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. ' - type: integer + type: string required: - - vlan_mode - SwitchState: + - scope + - used_for + - type + InterfaceQueryResponseV4N7: properties: - bridge_id: - description: 'The switch bridge ID - - ' + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' type: string - default_vlan_id: - description: 'Default VLAN ID is 1. - - ' - format: int32 - type: integer - designated_bridge_id: - description: "The designated bridge ID. \n" + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' type: string - last_topology_change: - description: 'Last topology change. - - ' + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + element_id: + description: Element Id type: string - max_hops: - description: Max Hops - format: int32 - type: integer - mstp_enabled: - description: 'The MSTP enabled. True or False. - - ' - type: boolean - root_bridge_id: - description: Root Bridge Id + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id type: string - root_path_cost: - description: Root Path Cost - format: int32 - type: integer - root_port: - description: Root Port + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' type: string - stp_aging_timer: - description: "The STP aging Timer between 10 - 1000000 seconds. \ - \ \n" - format: int32 - type: integer - 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: "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: 'The length of Max Age time that the switch retains information - learned from BPDUs, set the value between 6 - 40 seconds. - - ' - format: int32 + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' type: integer - stp_mode: - description: 'The STP Mode is RSTP, default STP mode is RSTP - - ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' type: string - stp_priority: - description: 'The Priority value is between 0 - 61440, in multiples of 4096. - - ' - format: int32 - type: integer - TrackInterface: - properties: - interface_id: - description: 'The interface ID - - ' + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' type: string - reduce_priority: - description: 'Reduce priority of the spoke HA config. - - ' - format: int32 - type: integer - TrackV2: - properties: - interfaces: - description: 'The details of the interfaces. - - ' - items: - $ref: '#/components/schemas/TrackInterface' - type: array - waninterfaces: - description: 'Waninterfaces: Valid ' + nat_pools: + description: 'Nat Pools: Valid ' items: - $ref: '#/components/schemas/TrackWANInterface' + $ref: '#/components/schemas/NatPool' type: array - TrackWANInterface: - properties: - reduce_priority: - description: 'Reduce priority of the spoke HA config. - - ' + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' format: int32 type: integer - wan_interface_id: - description: 'The WAN interface ID - - ' + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' type: string - VRF: - properties: - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. - - ' + network_context_id: + description: Network Context Id type: string - vrf_context_name: - description: 'The VFR context name. - - ' + parent: + description: Parent type: string - VffInventoryOperation: - enum: - - grant - - return - - revoke - type: string - VffLicense: - properties: - allowed_ions: - description: 'The number of allowed ions. - - ' - format: int32 - type: integer - id: - description: 'The ID of ION. - - ' + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL type: string - model: - description: 'The model of the ION. - - ' + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' type: string required: - - model - VffLicenseQuery: + - scope + - used_for + - type + InterfaceQueryResponseV4N8: properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of vff licenses that match the query - parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number of vff licenses deleted for a time frame. - - ' + admin_up: + description: Admin Up type: boolean - group_by: - description: 'Group the vff licenses for the query. - - ' + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' items: - description: Group By + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces type: string type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port id: - description: "List the vff licenses by ID. \n" + description: 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 + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' 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. - - ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' items: - description: Retrieved Fields + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids type: string type: array - retrieved_fields_mask: - description: 'List the fields to query. - - ' + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceQueryResponseV4N9: + properties: + admin_up: + description: Admin Up 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 + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + directed_broadcast: + description: Directed Broadcast + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' type: integer - VffLicenseState: - properties: - deployed_ions: - description: 'The number of deployed IONs. - - ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' format: int32 type: integer - id: - description: 'The ID of the vff license. - - ' + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' type: string - VffLicenseStateQuery: + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N1: properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of vff license states that match the - query parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number of vff license states deleted for a time frame. - - ' + admin_up: + description: Admin Up type: boolean - group_by: - description: 'Group the vff license states for the query. - - ' + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' items: - description: Group By + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces type: string type: array + bypass_pair: + $ref: '#/components/schemas/BypassPair' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port id: - description: "List the vff license states by ID. \n" + description: Id type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. - - ' - format: int64 + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' type: integer - limit: - description: 'The query limit. - - ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' format: int32 type: integer - next_query: - description: 'The limit. + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - used_for + - type + InterfaceScreenV4N10: + properties: + admin_up: + description: 'The interface admin state. ' - type: object - query_params: - description: 'Query using query parameters. + type: boolean + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. ' - type: object - retrieved_fields: - description: 'Retrieve information from a field. + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: 'The bound interfaces. ' items: - description: Retrieved Fields + description: Bound Interfaces type: string type: array - retrieved_fields_mask: - description: 'List the fields to query. + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: 'The details of the bypass pair. ' - type: boolean - sort_params: - description: 'Specify the order in which you want the search criteria to - display. + description: + description: 'The interface description. Max size = 256. ' - type: object - total_count: - description: 'The total number of query parameters. + devicemgmt_policysetstack_id: + description: 'The device management policy set stack ID. ' - format: int64 - type: integer - VffLicenseStateV2: - properties: - deployed_ions: - description: 'The number of deployed IONs. + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. ' - format: int32 - type: integer - id: - description: 'The ID of the vff license. + directed_broadcast: + description: 'The directed broadcast. ' - type: string - source_license_id: - description: 'The source license ID of the IONs. + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. + + ' + id: + description: 'The interface ID. ' type: string - source_tenant_id: - description: 'The source tenant ID. + ipfixcollectorcontext_id: + description: 'The IPFIX collector context ID. ' type: string - VffLicenseV2: - properties: - allocated_ions: - description: 'The number of allocated IONs in the inventory. + ipfixfiltercontext_id: + description: 'The IPFIX filter context ID. ' - format: int32 - type: integer - allowed_ions: - description: 'The maximum number of IONs that are allowed. + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. ' - format: int32 - type: integer - id: - description: 'The ID of the IONs. + mac_address: + description: 'The interface configuration MAC address. ' type: string - model: - description: 'The model of the ION devices. + mtu: + description: 'The MTU value of the interface. ' - type: string - source_license_id: - description: 'The source license ID of the IONs. + type: integer + name: + description: 'The name of the interface state. Max size = 128. ' type: string - source_tenant_id: - description: 'The source tenant ID. + nat_address: + description: 'The NAT IP address. ' type: string - required: - - model - VffOperationInfo: - properties: - inventory_op: - $ref: '#/components/schemas/VffInventoryOperation' - description: 'The details of the operation in the inventory. + nat_pools: + description: 'The NAT pools information. ' - ions_count: - description: 'The number of IONs in the inventory. + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. ' + format: int32 type: integer - type: object - VffToken: - properties: - id: - description: 'The ID of the vff token. + nat_zone_id: + description: 'The NAT zone ID. ' type: string - ion_key: - description: 'The ION key. + network_context_id: + description: 'The network context ID. ' type: string - is_expired: - description: 'Is vff token expired. True or False. - - ' - type: boolean - is_multiuse: - description: 'Is the vff token multiuse. True or False. + parent: + description: 'The parent value = true. ' - type: boolean - is_revoked: - description: "Can the vff token be revoked. True or False. \n" - type: boolean - is_used: - description: 'Is the vff token in use. True or False. + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'The PPPoE config information. ' - type: boolean - secret_key: - description: 'The secret key. + scope: + description: 'The network scope. ' + enum: + - GLOBAL + - LOCAL type: string - valid_till_secs: - description: 'The token valid time in seconds. + secondary_ip_configs: + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. ' - format: int64 - type: integer - vfflicense_id: - description: 'The vff license ID. + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. ' - type: string - VffTokenQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of vff tokens that match the query parameters. + site_wan_interface_ids: + description: 'The site WAN interface IDs. ' - dest_page: - description: 'The destination page. + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'The static ARP config details. ' - format: int32 - type: integer - getDeleted: - description: 'The number of vff tokens deleted for a time frame. + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. ' - type: boolean - group_by: - description: 'Group the vff tokens for the query. + tags: + description: 'A information field that can be added to identify the interface. + Maximum 10 Unique tags of length 1024 each are allowed. ' items: - description: Group By + description: Tags type: string type: array - id: - description: "List the vff tokens by ID. \n" - type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. + type: + description: 'The interface type. ' - format: int64 - type: integer - limit: - description: 'The query limit. + type: string + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. ' - format: int32 - type: integer - next_query: - description: 'The limit. + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N11: + properties: + admin_up: + description: 'The interface admin state. ' - type: object - query_params: - description: 'Query using query parameters. + type: boolean + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. ' - type: object - retrieved_fields: - description: 'Retrieve information from a field. + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: 'The bound interfaces. ' items: - description: Retrieved Fields + description: Bound Interfaces type: string type: array - retrieved_fields_mask: - description: 'List the fields to query. + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: 'The details of the bypass pair. ' - type: boolean - sort_params: - description: 'Specify the order in which you want the search criteria to - display. + cellular_config: + $ref: '#/components/schemas/CellularInterfaceConfig' + description: 'Cellular Config: Valid ' + description: + description: 'The interface description. Max size = 256. ' - type: object - total_count: - description: 'The total number of query parameters. + devicemgmt_policysetstack_id: + description: 'The device management policy set stack ID. ' - format: int64 - type: integer - VffTokenQueryFilter: - properties: - id: - description: 'The ID of the vff token. + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. ' - type: string - ion_key: - description: 'The ION key. + directed_broadcast: + description: 'The directed broadcast. + + ' + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. + + ' + id: + description: 'The interface ID. ' type: string - is_expired: - description: 'Is vff token expired. True or False. + ipfixcollectorcontext_id: + description: 'The IPFIX collector context ID. ' - type: boolean - is_multiuse: - description: 'Is the vff token multiuse. True or False. + type: string + ipfixfiltercontext_id: + description: 'The IPFIX filter context ID. ' - type: boolean - is_revoked: - description: "Can the vff token be revoked. True or False. \n" - type: boolean - is_used: - description: 'Is the vff token in use. True or False. + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. ' - type: boolean - secret_key: - description: 'The secret key. + mac_address: + description: 'The interface configuration MAC address. ' type: string - valid_till_secs: - description: 'The token valid time in seconds. + mtu: + description: 'The MTU value of the interface. ' - format: int64 type: integer - vfflicense_id: - description: 'The vff license ID. + multicast_config: + $ref: '#/components/schemas/MulticastInterfaceConfig' + description: 'Multicast Config: Valid ' + name: + description: 'The name of the interface state. Max size = 128. ' type: string - VffTokenScreen: - properties: - id: - description: 'The ID of the vff token. + nat_address: + description: 'The NAT IP address. ' type: string - ion_key: - description: 'The ION key. + nat_pools: + description: 'The NAT pools information. + + ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. + + ' + format: int32 + type: integer + nat_zone_id: + description: 'The NAT zone ID. ' type: string - is_expired: - description: 'Is vff token expired. True or False. + network_context_id: + description: 'The network context ID. ' - type: boolean - is_multiuse: - description: 'Is the vff token multiuse. True or False. + type: string + parent: + description: 'The parent value = true. ' - type: boolean - is_revoked: - description: "Can the vff token be revoked. True or False. \n" - type: boolean - is_used: - description: 'Is the vff token in use. True or False. + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'The PPPoE config information. ' - type: boolean - secret_key: - description: 'The secret key. + scope: + description: 'The network scope. ' + enum: + - GLOBAL + - LOCAL type: string - valid_till_secs: - description: 'The token valid time in seconds. + secondary_ip_configs: + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. ' - format: int64 - type: integer - vfflicense_id: - description: 'The vff license ID. + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'The static ARP config details. + + ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. + + ' + tags: + description: 'A information field that can be added to identify the interface. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The interface type. ' type: string - VlanConfig: + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. + + ' + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N12: properties: - element_vlan_unique_id: - description: 'The element VLAN unique ID. + admin_up: + description: 'The interface admin state. + + ' + type: boolean + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. + + ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: 'The bound interfaces. + + ' + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: 'The details of the bypass pair. + + ' + cellular_config: + $ref: '#/components/schemas/CellularInterfaceConfig' + description: 'Cellular Config: Valid ' + description: + description: 'The interface description. Max size = 256. + + ' + devicemgmt_policysetstack_id: + description: 'The device management policy set stack ID. ' type: string - mstp_instance: - description: Mstp Instance - format: int32 - type: integer - vlan_id: - description: 'The VLAN ID. + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. ' - format: int32 - type: integer - voice_enabled: - description: 'The voice enabled VLAN. + directed_broadcast: + description: 'The directed broadcast. ' type: boolean - X509Objects: - properties: - certHolder: - type: object - certificate: - description: Certificate + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. + + ' + id: + description: 'The interface ID. + + ' type: string - is_local_ca_cert_set: - description: Is Local Ca Cert Set - type: boolean - is_remote_ca_cert_set: - description: Is Remote Ca Cert Set - type: boolean - keyPair: - type: object - local_ca_certificate: - description: Local Ca Certificate + ipfixcollectorcontext_id: + description: 'The IPFIX collector context ID. + + ' type: string - local_ca_certs_set: - description: Local Ca Certs Set - items: - type: object - type: array - passphrase: - description: Passphrase + ipfixfiltercontext_id: + description: 'The IPFIX filter context ID. + + ' type: string - private_key: - description: Private Key + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. + + ' + ipv6_config: + $ref: '#/components/schemas/Ipv6Config' + description: 'Ipv6 Config: Valid Valid ' + mac_address: + description: 'The interface configuration MAC address. + + ' + type: string + mtu: + description: 'The MTU value of the interface. + + ' + type: integer + multicast_config: + $ref: '#/components/schemas/MulticastInterfaceConfig' + description: 'Multicast Config: Valid ' + name: + description: 'The name of the interface state. Max size = 128. + + ' + type: string + nat_address: + description: 'The NAT IP address. + + ' + 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) ' + type: string + nat_pools: + description: 'The NAT pools information. + + ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. + + ' + format: int32 + type: integer + nat_port_v6: + description: 'Nat Port V6: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'The NAT zone ID. + + ' + type: string + network_context_id: + description: 'The network context ID. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'The PPPoE config information. + + ' + scope: + description: 'The network scope. + + ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'The static ARP config details. + + ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. + + ' + tags: + description: 'A information field that can be added to identify the interface. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The interface type. + + ' + type: string + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. + + ' + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N13: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + authentication_config: + $ref: '#/components/schemas/AuthenticationConfig' + description: 'Authentication Config: Valid ' + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + cellular_config: + $ref: '#/components/schemas/CellularInterfaceConfig' + description: 'Cellular Config: Valid ' + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + directed_broadcast: + description: Directed Broadcast + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + interface_profile_id: + description: Interface Profile Id + type: string + ipfixcollectorcontext_id: + description: Ipfixcollectorcontext Id + type: string + ipfixfiltercontext_id: + description: Ipfixfiltercontext Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + ipv6_config: + $ref: '#/components/schemas/Ipv6Config' + description: 'Ipv6 Config: Valid Valid ' + lldp_enabled: + description: Lldp Enabled + type: boolean + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + multicast_config: + $ref: '#/components/schemas/MulticastInterfaceConfig' + description: 'Multicast Config: Valid ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + 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) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_port_v6: + description: 'Nat Port V6: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + poe_enabled: + description: Poe Enabled + type: boolean + power_usage_threshold: + description: 'Power Usage Threshold: ValidateDecimal(allowZero = true, increment + = 0, max = 0, error = INTERFACE_CONFIG_INVALID_POE_POWER_USAGE_THRESHOLD: + Invalid Interface configuration. Invalid PoE alarm threshold value {}. + Valid values are in the range 50-100., min = 0) ' + format: int32 + type: integer + pppoe_config: + $ref: '#/components/schemas/PppoEInterfaceConfig' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'Secondary Ip Configs: Size(max = 8, error = INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT: + Invalid interface configuration. Secondary IPs exceed the supported limit + of 8, min = 0) ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'Static Arp Configs: Size(max = 32, error = INTERFACE_CONFIG_STATIC_ARP_EXCEEDS_LIMIT: + Invalid interface configuration. Static ARP entries exceed the supported + limit of 16, min = 0) ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + switch_port_config: + $ref: '#/components/schemas/SwitchPortConfig' + description: 'Switch Port Config: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + vlan_config: + $ref: '#/components/schemas/VlanConfig' + description: 'Vlan Config: Valid ' + required: + - scope + - used_for + - type + InterfaceScreenV4N14: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + authentication_config: + $ref: '#/components/schemas/AuthenticationConfig' + description: 'Authentication Config: Valid ' + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + cellular_config: + $ref: '#/components/schemas/CellularInterfaceConfig' + description: 'Cellular Config: Valid ' + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + directed_broadcast: + description: Directed Broadcast + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + interface_profile_id: + description: Interface Profile Id + type: string + ipfixcollectorcontext_id: + description: Ipfixcollectorcontext Id + type: string + ipfixfiltercontext_id: + description: Ipfixfiltercontext Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + ipv6_config: + $ref: '#/components/schemas/Ipv6Config' + description: 'Ipv6 Config: Valid Valid ' + lldp_enabled: + description: Lldp Enabled + type: boolean + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + multicast_config: + $ref: '#/components/schemas/MulticastInterfaceConfig' + description: 'Multicast Config: Valid ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + 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) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_port_v6: + description: 'Nat Port V6: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + poe_enabled: + description: Poe Enabled + type: boolean + power_usage_threshold: + description: 'Power Usage Threshold: ValidateDecimal(allowZero = true, increment + = 0, max = 0, error = INTERFACE_CONFIG_INVALID_POE_POWER_USAGE_THRESHOLD: + Invalid Interface configuration. Invalid PoE alarm threshold value {}. + Valid values are in the range 50-100., min = 0) ' + format: int32 + type: integer + pppoe_config: + $ref: '#/components/schemas/PppoEInterfaceConfig' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'Secondary Ip Configs: Size(max = 8, error = INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT: + Invalid interface configuration. Secondary IPs exceed the supported limit + of 8, min = 0) ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'Static Arp Configs: Size(max = 32, error = INTERFACE_CONFIG_STATIC_ARP_EXCEEDS_LIMIT: + Invalid interface configuration. Static ARP entries exceed the supported + limit of 16, min = 0) ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + switch_port_config: + $ref: '#/components/schemas/SwitchPortConfig' + description: 'Switch Port Config: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + vlan_config: + $ref: '#/components/schemas/VlanConfig' + description: 'Vlan Config: Valid ' + required: + - scope + - used_for + - type + InterfaceScreenV4N2: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - used_for + - type + InterfaceScreenV4N3: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - used_for + - type + InterfaceScreenV4N4: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N5: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N6: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N7: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N8: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceScreenV4N9: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + directed_broadcast: + description: Directed Broadcast + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceState: + properties: + cellular_state: + $ref: '#/components/schemas/CellularState' + description: 'The details of the cellular state. + + ' + device: + description: 'The device. + + ' + type: string + disabled: + description: 'List the element interfaces in a disabled state. + + ' + type: boolean + disabled_reason: + description: 'List the reason for the disabled state. + + ' + type: string + dns_v4_config: + $ref: '#/components/schemas/DNS' + description: "The DNS V4 configurations. \n" + dns_v6_config: + $ref: '#/components/schemas/DNS' + description: "The DNS V6 configurations. \n" + effective_vlans: + description: 'The number of effective VLANs. + + ' + items: + description: Effective Vlans + type: integer + type: array + element_id: + description: 'The element ID. + + ' + type: string + extended_state: + description: 'The extended state of the interface. + + ' + type: string + id: + description: 'The interface ID. + + ' + type: string + ike_algo: + description: 'The IKE algorithm. (value = true). + + ' + type: string + ike_last_rekeyed: + description: "The last rekeyed IKE. (value = true). \n" + format: int64 + type: integer + ike_next_rekey: + description: 'The next rekey IKE. (value = true). + + ' + format: int64 + type: integer + inactive: + description: 'Lists if the interface state is inactive. + + ' + type: boolean + inactive_reason: + description: 'Reason the interface state is inactive. Max size = 5000. + + ' + type: string + index: + description: 'Index: JsonIgnore(value = true) ' + format: int32 + type: integer + ipsec_algo: + description: 'The IPsec algorithm. (value = true). + + ' + type: string + ipsec_last_rekeyed: + description: "The last rekeyed IPsec. (value = true). \n" + format: int64 + type: integer + ipsec_next_rekey: + description: 'The next IPsec rekey. (value = true). + + ' + format: int64 + type: integer + ipv4_addresses: + description: 'The IPv4 addresses configured for the interface. + + ' + items: + description: Ipv4 Addresses + type: string + type: array + ipv4_addresses_changed: + description: 'If any IPv4 addresses are change. True or False. + + ' + type: boolean + ipv6_addresses: + description: 'The IPv6 addresses configured for the interface. + + ' + items: + description: Ipv6 Addresses + type: string + type: array + ipv6_addresses_changed: + description: 'If any IPv6 addresses are change. True or False. + + ' + type: boolean + last_state_change: + description: "The last state that was changed. \n" + format: int64 + type: integer + link_local_address: + description: "The link local address. \n" + type: string + lldp_enabled: + description: 'Lldp enabled. True or False. + + ' + type: boolean + local_tunnel_v4_addr: + description: 'The local tunnel v4 address. (value = true). + + ' + type: string + mac_address: + description: 'The MAC address. + + ' + type: string + name: + description: 'The name of the interface state. + + ' + type: string + negotiated_mtu: + description: "The negotiated maximum transmission unit. \n" + format: int32 + type: integer + operational_state: + description: "The operational state. True or False.. \n" + type: string + operational_state_changed: + description: 'If any operational state has changed. True or False. + + ' + type: boolean + poe_state: + $ref: '#/components/schemas/PoeStateS' + description: 'The power over ethernet state details. + + ' + port: + $ref: '#/components/schemas/Port' + description: 'The port details. + + ' + region: + description: Region + type: string + remote_host_name: + description: "The remote host name. \n" + type: string + remote_v4_addr: + description: 'The remote v4 address. + + ' + type: string + routes: + description: "The route details. \n" + items: + $ref: '#/components/schemas/Route' + type: array + routes_v6: + description: "The v6 route details. \n" + items: + $ref: '#/components/schemas/Ipv6Route' + type: array + secondary_ipv4_addresses: + description: 'The secondary IPV4 addresses configured. + + ' + items: + description: Secondary Ipv4 Addresses + type: string + type: array + state: + description: 'The state. (value = true). + + ' + type: boolean + stp_state: + $ref: '#/components/schemas/STPStateS' + description: 'The stp state details. + + ' + svi_state: + $ref: '#/components/schemas/SVIStateS' + description: 'The svi state details. + + ' + InterfaceStateV3N1: + properties: + device: + description: Device + type: string + dns_v4_config: + $ref: '#/components/schemas/DNS' + description: 'Dns V4 Config: Valid ' + dns_v6_config: + $ref: '#/components/schemas/IPv6DNS' + description: Dns V6 Config + element_id: + description: Element Id + type: string + extended_state: + description: Extended State + type: string + id: + description: Id + type: string + ipv4_addresses: + description: Ipv4 Addresses + items: + description: Ipv4 Addresses + type: string + type: array + ipv6_addresses: + description: Ipv6 Addresses + items: + description: Ipv6 Addresses + type: string + type: array + last_state_change: + description: Last State Change + format: int64 + type: integer + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + negotiated_mtu: + description: Negotiated Mtu + format: int32 + type: integer + operational_state: + description: Operational State + type: string + port: + $ref: '#/components/schemas/Port' + description: Port + remote_host_name: + description: Remote Host Name + type: string + remote_v4_addr: + description: Remote V4 Addr + type: string + routes: + description: Routes + items: + $ref: '#/components/schemas/Route' + type: array + service_link: + $ref: '#/components/schemas/ServiceLink' + description: Service Link + InterfaceStateV3N2: + properties: + device: + description: Device + type: string + dns_v4_config: + $ref: '#/components/schemas/DNS' + description: 'Dns V4 Config: Valid ' + dns_v6_config: + $ref: '#/components/schemas/IPv6DNS' + description: Dns V6 Config + element_id: + description: Element Id + type: string + extended_state: + description: Extended State + type: string + id: + description: Id + type: string + ipv4_addresses: + description: Ipv4 Addresses + items: + description: Ipv4 Addresses + type: string + type: array + ipv6_addresses: + description: Ipv6 Addresses + items: + description: Ipv6 Addresses + type: string + type: array + last_state_change: + description: Last State Change + format: int64 + type: integer + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + negotiated_mtu: + description: Negotiated Mtu + format: int32 + type: integer + operational_state: + description: Operational State + type: string + port: + $ref: '#/components/schemas/Port' + description: Port + remote_host_name: + description: Remote Host Name + type: string + remote_v4_addr: + description: Remote V4 Addr + type: string + routes: + description: Routes + items: + $ref: '#/components/schemas/Route' + type: array + secondary_ipv4_addresses: + description: Secondary Ipv4 Addresses + items: + description: Secondary Ipv4 Addresses + type: string + type: array + service_link: + $ref: '#/components/schemas/ServiceLink' + description: Service Link + InterfaceStateV3N3: + properties: + cellular_state: + $ref: '#/components/schemas/CellularState' + description: Cellular State + device: + description: Device + type: string + dns_v4_config: + $ref: '#/components/schemas/DNS' + description: 'Dns V4 Config: Valid ' + dns_v6_config: + $ref: '#/components/schemas/IPv6DNS' + description: Dns V6 Config + element_id: + description: Element Id + type: string + extended_state: + description: Extended State + type: string + id: + description: Id + type: string + ipv4_addresses: + description: Ipv4 Addresses + items: + description: Ipv4 Addresses + type: string + type: array + ipv6_addresses: + description: Ipv6 Addresses + items: + description: Ipv6 Addresses + type: string + type: array + last_state_change: + description: Last State Change + format: int64 + type: integer + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + negotiated_mtu: + description: Negotiated Mtu + format: int32 + type: integer + operational_state: + description: Operational State + type: string + port: + $ref: '#/components/schemas/Port' + description: Port + remote_host_name: + description: Remote Host Name + type: string + remote_v4_addr: + description: Remote V4 Addr + type: string + routes: + description: Routes + items: + $ref: '#/components/schemas/Route' + type: array + secondary_ipv4_addresses: + description: Secondary Ipv4 Addresses + items: + description: Secondary Ipv4 Addresses + type: string + type: array + service_link: + $ref: '#/components/schemas/ServiceLink' + description: Service Link + InterfaceStateV3N4: + properties: + cellular_state: + $ref: '#/components/schemas/CellularState' + description: Cellular State + device: + description: Device + type: string + dns_v4_config: + $ref: '#/components/schemas/DNS' + description: 'Dns V4 Config: Valid ' + dns_v6_config: + $ref: '#/components/schemas/IPv6DNS' + description: Dns V6 Config + element_id: + description: Element Id + type: string + extended_state: + description: Extended State + type: string + id: + description: Id + type: string + ipv4_addresses: + description: Ipv4 Addresses + items: + description: Ipv4 Addresses + type: string + type: array + ipv6_addresses: + description: Ipv6 Addresses + items: + description: Ipv6 Addresses + type: string + type: array + last_state_change: + description: Last State Change + format: int64 + type: integer + link_local_address: + description: Link Local Address + type: string + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + negotiated_mtu: + description: Negotiated Mtu + format: int32 + type: integer + operational_state: + description: Operational State + type: string + port: + $ref: '#/components/schemas/Port' + description: Port + remote_host_name: + description: Remote Host Name + type: string + remote_v4_addr: + description: Remote V4 Addr + type: string + routes: + description: Routes + items: + $ref: '#/components/schemas/Route' + type: array + routes_v6: + description: Routes V6 + items: + $ref: '#/components/schemas/Ipv6Route' + type: array + secondary_ipv4_addresses: + description: Secondary Ipv4 Addresses + items: + description: Secondary Ipv4 Addresses + type: string + type: array + service_link: + $ref: '#/components/schemas/ServiceLink' + description: Service Link + InterfaceStateV3N5: + properties: + cellular_state: + $ref: '#/components/schemas/CellularState' + description: 'The cellular state details. + + ' + device: + description: 'The ION device. + + ' + type: string + dns_v4_config: + $ref: '#/components/schemas/DNS' + description: 'The DNS v4 config details. + + ' + dns_v6_config: + $ref: '#/components/schemas/IPv6DNS' + 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. + + ' + type: string + extended_state: + description: 'The extended state. + + ' + type: string + id: + description: 'The interface ID. + + ' + type: string + ipv4_addresses: + description: "The IPv4 addresses configured for the interface. \n" + items: + description: Ipv4 Addresses + type: string + type: array + ipv6_addresses: + description: "The IPv6 addresses configured for the interface. \n" + items: + description: Ipv6 Addresses + type: string + type: array + last_state_change: + description: 'The last state change of the device. + + ' + format: int64 + type: integer + 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. + + ' + type: string + name: + description: 'The name of the interface state. Max size = 128. + + ' + type: string + negotiated_mtu: + description: 'The negotiated IP MTU value. + + ' + format: int32 + type: integer + operational_state: + description: 'The operational state. + + ' + type: string + poe_state: + $ref: '#/components/schemas/PoeStateS' + description: Poe State + port: + $ref: '#/components/schemas/Port' + description: 'The start and end port details. + + ' + remote_host_name: + description: 'The remote host name. + + ' + type: string + remote_v4_addr: + description: 'The remote IPv4 address. + + ' + type: string + routes: + description: "The routing details. \n" + items: + $ref: '#/components/schemas/Route' + type: array + routes_v6: + description: 'The route v6 details. + + ' + items: + $ref: '#/components/schemas/Ipv6Route' + type: array + secondary_ipv4_addresses: + description: 'The secondary IPv4 addresses. + + ' + items: + description: Secondary Ipv4 Addresses + type: string + type: array + service_link: + $ref: '#/components/schemas/ServiceLink' + description: 'The service link details ServiceLink. + + ' + stp_state: + $ref: '#/components/schemas/STPStateS' + description: 'The STP state details. + + ' + svi_state: + $ref: '#/components/schemas/SVIStateS' + description: 'The svi details. + + ' + InterfaceV4N1: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. + + ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: 'The bound interfaces. + + ' + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPair' + description: 'The details of the bypass pair. + + ' + description: + description: 'The interface description. Max size = 256. + + ' + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. + + ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. + + ' + id: + description: 'The interface ID. + + ' + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. + + ' + mac_address: + description: 'The interface configuration MAC address. + + ' + type: string + mtu: + description: 'The MTU value of the interface. + + ' + type: integer + name: + description: 'The name of the interface state. Max size = 128. + + ' + type: string + nat_address: + description: 'The NAT IP address. + + ' + type: string + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. + + ' + format: int32 + type: integer + network_context_id: + description: 'The network context ID. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'The PPPoE config information. + + ' + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. + + ' + type: + description: 'The interface type. + + ' + type: string + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. + + ' + type: string + required: + - used_for + - type + InterfaceV4N10: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. + + ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: 'The bound interfaces. + + ' + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: 'The details of the bypass pair. + + ' + description: + description: 'The interface description. Max size = 256. + + ' + devicemgmt_policysetstack_id: + description: 'The device management policy set stack ID. + + ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. + + ' + directed_broadcast: + description: 'The directed broadcast. + + ' + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. + + ' + id: + description: 'The interface ID. + + ' + type: string + ipfixcollectorcontext_id: + description: 'The IPFIX collector context ID. + + ' + type: string + ipfixfiltercontext_id: + description: 'The IPFIX filter context ID. + + ' + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. + + ' + mac_address: + description: 'The interface configuration MAC address. + + ' + type: string + mtu: + description: 'The MTU value of the interface. + + ' + type: integer + name: + description: 'The name of the interface state. Max size = 128. + + ' + type: string + nat_address: + description: 'The NAT IP address. + + ' + type: string + nat_pools: + description: 'The NAT pools information. + + ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. + + ' + format: int32 + type: integer + nat_zone_id: + description: 'The NAT zone ID. + + ' + type: string + network_context_id: + description: 'The network context ID. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'The PPPoE config information. + + ' + scope: + description: 'The network scope. + + ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'The static ARP config details. + + ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. + + ' + tags: + description: 'A information field that can be added to identify the interface. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The interface type. + + ' + type: string + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. + + ' + type: string + InterfaceV4N11: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. + + ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: 'The bound interfaces. + + ' + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: 'The details of the bypass pair. + + ' + cellular_config: + $ref: '#/components/schemas/CellularInterfaceConfig' + description: 'Cellular Config: Valid ' + description: + description: 'The interface description. Max size = 256. + + ' + devicemgmt_policysetstack_id: + description: 'The device management policy set stack ID. + + ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. + + ' + directed_broadcast: + description: 'The directed broadcast. + + ' + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. + + ' + id: + description: 'The interface ID. + + ' + type: string + ipfixcollectorcontext_id: + description: 'The IPFIX collector context ID. + + ' + type: string + ipfixfiltercontext_id: + description: 'The IPFIX filter context ID. + + ' + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. + + ' + mac_address: + description: 'The interface configuration MAC address. + + ' + type: string + mtu: + description: 'The MTU value of the interface. + + ' + type: integer + multicast_config: + $ref: '#/components/schemas/MulticastInterfaceConfig' + description: 'Multicast Config: Valid ' + name: + description: 'The name of the interface state. Max size = 128. + + ' + type: string + nat_address: + description: 'The NAT IP address. + + ' + type: string + nat_pools: + description: 'The NAT pools information. + + ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. + + ' + format: int32 + type: integer + nat_zone_id: + description: 'The NAT zone ID. + + ' + type: string + network_context_id: + description: 'The network context ID. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'The PPPoE config information. + + ' + scope: + description: 'The network scope. + + ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'The static ARP config details. + + ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. + + ' + tags: + description: 'A information field that can be added to identify the interface. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The interface type. + + ' + type: string + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. + + ' + type: string + required: + - scope + - used_for + - type + InterfaceV4N12: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. + + ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: 'The bound interfaces. + + ' + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: 'The details of the bypass pair. + + ' + cellular_config: + $ref: '#/components/schemas/CellularInterfaceConfig' + description: 'Cellular Config: Valid ' + description: + description: 'The interface description. Max size = 256. + + ' + devicemgmt_policysetstack_id: + description: 'The device management policy set stack ID. + + ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. + + ' + directed_broadcast: + description: 'The directed broadcast. + + ' + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. + + ' + id: + description: 'The interface ID. + + ' + type: string + ipfixcollectorcontext_id: + description: 'The IPFIX collector context ID. + + ' + type: string + ipfixfiltercontext_id: + description: 'The IPFIX filter context ID. + + ' + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. + + ' + ipv6_config: + $ref: '#/components/schemas/Ipv6Config' + description: 'Ipv6 Config: Valid Valid ' + mac_address: + description: 'The interface configuration MAC address. + + ' + type: string + mtu: + description: 'The MTU value of the interface. + + ' + type: integer + multicast_config: + $ref: '#/components/schemas/MulticastInterfaceConfig' + description: 'Multicast Config: Valid ' + name: + description: 'The name of the interface state. Max size = 128. + + ' + type: string + nat_address: + description: 'The NAT IP address. + + ' + 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) ' + type: string + nat_pools: + description: 'The NAT pools information. + + ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. + + ' + format: int32 + type: integer + nat_port_v6: + description: 'Nat Port V6: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'The NAT zone ID. + + ' + type: string + network_context_id: + description: 'The network context ID. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'The PPPoE config information. + + ' + scope: + description: 'The network scope. + + ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'The static ARP config details. + + ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. + + ' + tags: + description: 'A information field that can be added to identify the interface. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The interface type. + + ' + type: string + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. + + ' + type: string + required: + - scope + - used_for + - type + InterfaceV4N13: + properties: + admin_up: + description: 'The interface admin state. + + ' + type: boolean + attached_lan_networks: + description: 'The attached lan network ID and vlan ID. + + ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + authentication_config: + $ref: '#/components/schemas/AuthenticationConfig' + description: 'Authentication Config: Valid ' + bound_interfaces: + description: 'The bound interfaces. + + ' + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: 'The details of the bypass pair. + + ' + cellular_config: + $ref: '#/components/schemas/CellularInterfaceConfig' + description: 'Cellular Config: Valid ' + description: + description: 'The interface description. Max size = 256. + + ' + devicemgmt_policysetstack_id: + description: 'The device management policy set stack ID. + + ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'The DHCP relay information. + + ' + directed_broadcast: + description: 'The directed broadcast. + + ' + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: 'The ethernet port information. + + ' + id: + description: 'The interface ID. + + ' + type: string + interface_profile_id: + description: Interface Profile Id + type: string + ipfixcollectorcontext_id: + description: 'The IPFIX collector context ID. + + ' + type: string + ipfixfiltercontext_id: + description: 'The IPFIX filter context ID. + + ' + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'The ipv4 config information. + + ' + ipv6_config: + $ref: '#/components/schemas/Ipv6Config' + description: 'The ipv6 config information. + + ' + lldp_enabled: + description: 'If LLDP enabled. True/False. + + ' + type: boolean + mac_address: + description: 'The interface configuration MAC address. + + ' + type: string + mtu: + description: 'The MTU value of the interface. + + ' + type: integer + multicast_config: + $ref: '#/components/schemas/MulticastInterfaceConfig' + description: 'The multicast config details. + + ' + name: + description: 'The name of the interface state. Max size = 128. + + ' + type: string + nat_address: + description: 'The NAT IP address. + + ' + 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) ' + type: string + nat_pools: + description: 'The NAT pools information. + + ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'The NAT port. LAN,WAN,Internet bypass ports cannot be part + of logical interface groups. + + ' + format: int32 + type: integer + nat_port_v6: + description: "The NAT IPv6 port.Internet bypass ports cannot be part of\ + \ logical interface groups. \n" + format: int32 + type: integer + nat_zone_id: + description: 'The NAT zone ID. + + ' + type: string + network_context_id: + description: 'The network context ID. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + poe_enabled: + description: 'PoE enabled = true/false. + + ' + type: boolean + power_usage_threshold: + description: 'The interface config PoE power usage threshold. Valid values + are in the range 50-100. + + ' + format: int32 + type: integer + pppoe_config: + $ref: '#/components/schemas/PppoEInterfaceConfig' + description: 'The PPPoE config information. + + ' + scope: + description: 'The network scope. + + ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'The interface secondary IP config. Secondary IPs exceed the + supported limit of 8. + + ' + site_wan_interface_ids: + description: 'The site WAN interface IDs. + + ' + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'The static ARP config details. + + ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'The sub interface vlan ID. + + ' + switch_port_config: + $ref: '#/components/schemas/SwitchPortConfig' + description: 'The switch port config details. + + ' + tags: + description: 'A information field that can be added to identify the interface. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The interface type. + + ' + type: string + used_for: + description: 'The interface used for value. The allowed values are public,private_wan,lan,none. + + ' + type: string + vlan_config: + $ref: '#/components/schemas/VlanConfig' + description: 'The VLAN config details. + + ' + required: + - scope + - used_for + - type + InterfaceV4N14: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + authentication_config: + $ref: '#/components/schemas/AuthenticationConfig' + description: 'Authentication Config: Valid ' + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + cellular_config: + $ref: '#/components/schemas/CellularInterfaceConfig' + description: 'Cellular Config: Valid ' + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + directed_broadcast: + description: Directed Broadcast + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + interface_profile_id: + description: Interface Profile Id + type: string + ipfixcollectorcontext_id: + description: Ipfixcollectorcontext Id + type: string + ipfixfiltercontext_id: + description: Ipfixfiltercontext Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + ipv6_config: + $ref: '#/components/schemas/Ipv6Config' + description: 'Ipv6 Config: Valid Valid ' + lldp_enabled: + description: Lldp Enabled + type: boolean + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + multicast_config: + $ref: '#/components/schemas/MulticastInterfaceConfig' + description: 'Multicast Config: Valid ' + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + 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) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_port_v6: + description: 'Nat Port V6: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + poe_enabled: + description: Poe Enabled + type: boolean + power_usage_threshold: + description: 'Power Usage Threshold: ValidateDecimal(allowZero = true, increment + = 0, max = 0, error = INTERFACE_CONFIG_INVALID_POE_POWER_USAGE_THRESHOLD: + Invalid Interface configuration. Invalid PoE alarm threshold value {}. + Valid values are in the range 50-100., min = 0) ' + format: int32 + type: integer + pppoe_config: + $ref: '#/components/schemas/PppoEInterfaceConfig' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + secondary_ip_configs: + description: 'Secondary Ip Configs: Size(max = 8, error = INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT: + Invalid interface configuration. Secondary IPs exceed the supported limit + of 8, min = 0) ' + items: + $ref: '#/components/schemas/SecondaryIPConfig' + type: array + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + static_arp_configs: + description: 'Static Arp Configs: Size(max = 32, error = INTERFACE_CONFIG_STATIC_ARP_EXCEEDS_LIMIT: + Invalid interface configuration. Static ARP entries exceed the supported + limit of 16, min = 0) ' + items: + $ref: '#/components/schemas/StaticARPConfig' + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + switch_port_config: + $ref: '#/components/schemas/SwitchPortConfig' + description: 'Switch Port Config: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + vlan_config: + $ref: '#/components/schemas/VlanConfig' + description: 'Vlan Config: Valid ' + required: + - scope + - used_for + - type + InterfaceV4N2: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - used_for + - type + InterfaceV4N3: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - used_for + - type + InterfaceV4N4: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceV4N5: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceV4N6: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceV4N7: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV1' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceV4N8: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InterfaceV4N9: + properties: + admin_up: + description: Admin Up + type: boolean + attached_lan_networks: + description: 'Attached Lan Networks: Valid ' + items: + $ref: '#/components/schemas/LanNetworkVlanMapping' + type: array + bound_interfaces: + description: Bound Interfaces + items: + description: Bound Interfaces + type: string + type: array + bypass_pair: + $ref: '#/components/schemas/BypassPairV2' + description: Bypass Pair + description: + description: 'Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: + Description length exceeds limit, min = 0) ' + type: string + devicemgmt_policysetstack_id: + description: 'Devicemgmt Policysetstack Id: Digits(fraction = 0, integer + = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) ' + type: string + dhcp_relay: + $ref: '#/components/schemas/DHCPRelay' + description: 'Dhcp Relay: Valid ' + directed_broadcast: + description: Directed Broadcast + type: boolean + ethernet_port: + $ref: '#/components/schemas/EthernetPort' + description: Ethernet Port + id: + description: Id + type: string + ipv4_config: + $ref: '#/components/schemas/Ipv4Config' + description: 'Ipv4 Config: Valid Valid ' + mac_address: + description: 'Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: + Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) ' + type: string + mtu: + description: 'Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: + MTU is not in the valid range., min = 0L) ' + type: integer + name: + description: 'Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of + the resource exceeds limit., min = 0) ' + type: string + nat_address: + description: 'Nat Address: IPAddress(allowEmpty = true, allowLinkLocal = + false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck + = false, error = INVALID_NAT_IP: NAT IP address is invalid., type = IP) ' + type: string + nat_pools: + description: 'Nat Pools: Valid ' + items: + $ref: '#/components/schemas/NatPool' + type: array + nat_port: + description: 'Nat Port: Range(max = 65535L, error = INTERFACE_CONFIG_INVALID_PORT: + LAN,WAN,Internet bypass ports cannot be part of logical interface groups., + min = 0L) ' + format: int32 + type: integer + nat_zone_id: + description: 'Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) ' + type: string + network_context_id: + description: Network Context Id + type: string + parent: + description: Parent + type: string + pppoe_config: + $ref: '#/components/schemas/PppoE' + description: 'Pppoe Config: Valid Valid ' + scope: + description: 'Scope: ValidateEnum(enumClass = classOf[NetworkScope], message + = Invalid enum string., nullAllowed = false) ' + enum: + - GLOBAL + - LOCAL + type: string + service_link_config: + $ref: '#/components/schemas/ServiceLinkV2' + description: 'Service Link Config: Valid Valid ' + site_wan_interface_ids: + description: Site Wan Interface Ids + items: + description: Site Wan Interface Ids + type: string + type: array + sub_interface: + $ref: '#/components/schemas/SubInterface' + description: 'Sub Interface: Valid ' + 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) ' + items: + description: Tags + type: string + type: array + type: + description: 'Type: ValidateEnum(enumClass = classOf[InterfaceType], error + = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) ' + type: string + used_for: + description: 'Used For: ValidateEnum(enumClass = classOf[UsedFor], error + = INTERFACE_CONFIG_INVALID_USEDFOR_VALUE: Invalid used for value specified.The + allowed values are public,private_wan,lan,none, nullAllowed = false) ' + type: string + required: + - scope + - used_for + - type + InventoryOperation: + enum: + - claim + - return + - revoke + - reuse + - retire + - recover + - remanufacture + - default + - invalid + - esp_allocate + - esp_received_stock + - esp_return + - esp_revoke + - esp_reuse + type: string + Ipv4Config: + properties: + dhcp_config: + $ref: '#/components/schemas/Ipv4Dhcp' + description: 'The DHCP config information. + + ' + dns_v4_config: + $ref: '#/components/schemas/DNS' + description: 'The DNS v4 config details. + + ' + pppoe_config: + $ref: '#/components/schemas/Ipv4Pppoe' + description: 'The PPoE config information. + + ' + routes: + description: 'The ethernet port routes. + + ' + items: + $ref: '#/components/schemas/Route' + type: array + static_config: + $ref: '#/components/schemas/Ipv4Static' + description: 'The IPv4 static address. + + ' + type: + description: 'The interface config type. Max = 12. + + ' + type: string + Ipv4Dhcp: + properties: + client_id: + description: 'The client ID. + + ' + type: string + hostname: + description: 'The IPv4 DHCP host name. + + ' + type: string + Ipv4Pppoe: + properties: + chap_passwd: + description: 'The PPPoE IPv4 CHAP password. + + ' + type: string + chap_user: + description: 'The PPPoE IPv4 CHAP user. + + ' + type: string + set_route: + description: "The set route for PPPoE IPv4. \n" + type: boolean + Ipv4Static: + properties: + 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 + Ipv6Dhcp: + properties: + client_id: + description: 'The client ID. + + ' + type: string + hostname: + description: 'The IPv6 DHCP host name. + + ' + type: string + Ipv6Route: + properties: + destination: + description: 'The route destination. + + ' + type: string + via: + description: 'The via IPv6 address. + + ' + type: string + Ipv6Static: + properties: + address: + description: Address + type: string + LanNetworkVlanMapping: + properties: + lan_network_id: + description: 'The LAN network ID. + + ' + type: string + vlan_id: + description: 'The VLAN ID. VLAN ID should be between 0 and 4095. + + ' + format: int32 + type: integer + LedConfig: + properties: + service_led_on: + description: Service Led On + type: boolean + 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 + Machine: + properties: + connected: + description: "The device is connected. True or False. \n" + type: boolean + console_conf_passphrase: + description: "The console password. \n" + type: string + em_element_id: + description: "The element ID. \n" + type: string + hw_id: + description: 'The hardware ID. + + ' + type: string + id: + description: Id + type: string + image_version: + description: 'The image version. + + ' + type: string + inventory_op: + 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 + is_eval: + description: Is Eval + type: boolean + machine_state: + 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 + type: string + manufacture_id: + description: 'The manufacture ID. + + ' + type: string + model_name: + description: "The model name of the device. \n" + type: string + ordering_info: + description: "The order information. \n" + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + description: Pki Op + renew_state: + 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 + type: string + ship_state: + 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 + token: + description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. + + ' + type: string + required: + - ship_state + - manufacture_id + - renew_state + - machine_state + - image_version + - model_name + - sl_no + - hw_id + MachineInfo: + properties: + connected: + description: "The device is connected. True or False. \n" + type: boolean + console_conf_passphrase: + description: "The console password. \n" + type: string + 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: + type: string + image_version: + description: 'The image version. + + ' + type: string + inventory_op: + $ref: '#/components/schemas/InventoryOperation' + description: 'The inventory lifecycle values. + + ' + machine_state: + $ref: '#/components/schemas/MachineState' + description: 'The various device states. + + ' + manufacture_id: + description: 'The manufacture ID. + + ' + type: string + model_name: + description: "The model name of the device. \n" + type: string + ordering_info: + description: "The order information. \n" + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + renew_state: + $ref: '#/components/schemas/MachineState' + description: 'The device renew states. + + ' + ship_state: + $ref: '#/components/schemas/MachineShipState' + description: 'The shipping status. + + ' + sl_no: + description: 'The serial number. + + ' + type: string + token: + description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. + + ' + type: string + type: object + MachineInfoV2N2: + properties: + connected: + type: boolean + console_conf_passphrase: + type: string + em_element_id: + type: string + esp_tenant_id: + type: string + hw_id: + type: string + id: + type: string + image_version: + type: string + inventory_op: + $ref: '#/components/schemas/InventoryOperation' + machine_state: + $ref: '#/components/schemas/MachineState' + manufacture_id: + type: string + model_name: + type: string + ordering_info: + type: string + owner_tenant_id: + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + renew_state: + $ref: '#/components/schemas/MachineState' + ship_state: + $ref: '#/components/schemas/MachineShipState' + sl_no: + type: string + token: + type: string + type: object + MachineInfoV2N3: + properties: + connected: + description: "The device is connected. True or False. \n" + type: boolean + console_conf_passphrase: + description: "The console password. \n" + type: string + em_element_id: + description: "The element ID. \n" + type: string + esp_tenant_id: + description: 'The MSP tenant ID. + + ' + type: string + hw_id: + description: 'The hardware ID. + + ' + type: string + id: + type: string + image_version: + description: 'The image version. + + ' + type: string + inventory_op: + $ref: '#/components/schemas/InventoryOperation' + description: 'The inventory lifecycle values. + + ' + machine_state: + $ref: '#/components/schemas/MachineState' + description: 'The various device states. + + ' + manufacture_id: + description: 'The manufacture ID. + + ' + type: string + model_name: + description: "The model name of the device. \n" + type: string + ordering_info: + description: "The order information. \n" + type: string + owner_tenant_id: + description: "The owner tenant ID. \n" + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + renew_state: + $ref: '#/components/schemas/MachineState' + description: 'The device renew states. + + ' + sales_order_number: + description: 'The sales order number. + + ' + type: string + ship_state: + $ref: '#/components/schemas/MachineShipState' + description: 'The shipping status. + + ' + sl_no: + type: string + token: + description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. + + ' + type: string + type: object + MachineQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of machines that match the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number machines deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the machines for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the machines 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 + MachineQueryFilterV2N1: + properties: + connected: + description: "The device is connected. True or False. \n" + type: boolean + console_conf_passphrase: + description: "The console password. \n" + type: string + 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. + + ' + type: string + inventory_op: + 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 + is_eval: + description: Is Eval + type: boolean + machine_state: + 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 + type: string + manufacture_id: + description: 'The manufacture ID. + + ' + type: string + model_name: + description: "The model name of the device. \n" + type: string + ordering_info: + description: "The order information. \n" + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + description: Pki Op + renew_state: + 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 + type: string + ship_state: + 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 + suspend_state: + description: 'The suspend 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 + type: string + token: + description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. + + ' + type: string + MachineQueryFilterV2N2: + properties: + connected: + description: Connected + type: boolean + console_conf_passphrase: + description: Console Conf Passphrase + type: string + em_element_id: + description: Em Element Id + type: string + esp_tenant_id: + description: 'Esp Tenant Id: JsonInclude(content = ALWAYS, contentFilter + = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' + type: string + hw_id: + description: Hardware Id + type: string + id: + description: Id + type: string + image_version: + description: Image Version + type: string + inventory_op: + description: Inventory Op + 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 + is_eval: + description: Is Eval + type: boolean + machine_state: + description: Machine State + 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 + type: string + manufacture_id: + description: Manufacture Id + type: string + model_name: + description: Model Name + type: string + ordering_info: + description: Ordering Info + type: string + owner_tenant_id: + description: 'Owner Tenant Id: JsonInclude(content = ALWAYS, contentFilter + = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + description: Pki Op + renew_state: + description: Renew State + 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 + type: string + ship_state: + description: Ship State + enum: + - MACHINE_SHIPPED + - MACHINE_SHIPPED_CORRECT_ADDRESS + - MACHINE_SHIPPED_WRONG_ADDRESS + - MACHINE_NOT_SHIPPED + type: string + sl_no: + description: Sl No + type: string + suspend_state: + description: Suspend State + 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 + type: string + token: + description: Token + type: string + MachineQueryFilterV2N3: + properties: + connected: + description: "The device is connected. True or False. \n" + type: boolean + console_conf_passphrase: + description: "The console password. \n" + type: string + em_element_id: + description: "The element ID. \n" + type: string + esp_tenant_id: + description: 'The MSP tenant ID. + + ' + type: string + hw_id: + description: 'The hardware ID. + + ' + type: string + id: + description: Id + type: string + image_version: + description: 'The image version. + + ' + type: string + inventory_op: + 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 + is_eval: + description: Is Eval + type: boolean + machine_state: + 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 + type: string + manufacture_id: + description: 'The manufacture ID. + + The manufacture ID. + + ' + type: string + model_name: + description: "The model name of the device. \n" + type: string + ordering_info: + description: "The order information. \n" + type: string + owner_tenant_id: + description: "The owner tenant ID. \n" + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + description: Pki Op + renew_state: + 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 + type: string + sales_order_number: + description: 'The sales order number. + + ' + type: string + ship_state: + description: 'The shipping status. + + ' + enum: + - MACHINE_SHIPPED + - MACHINE_SHIPPED_CORRECT_ADDRESS + - MACHINE_SHIPPED_WRONG_ADDRESS + - MACHINE_NOT_SHIPPED + type: string + sl_no: + description: Sl No + type: string + suspend_state: + description: 'The suspend state. + + ' + 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 + type: string + token: + description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. + + ' + type: string + MachineShipState: + enum: + - machine_shipped + - machine_shipped_correct_address + - machine_shipped_wrong_address + - machine_not_shipped + type: string + MachineState: + enum: + - manufactured + - manufactured_qa_pending + - manufactured_qa_ok + - manufactured_qa_not_ok + - manufactured_battery_test_pending + - manufactured_battery_test_start + - manufactured_battery_test_passed + - 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 + - allocated + - allocated_to_esp + - claim_pending + - initializing + - initialization_failed + - assigned + - claim_pending + - claimed + - claim_failed + - to_be_returned + - returned + - revoked + - machine_element_delete_pending + - return_failed + - received_stock + - remanufactured + - retired + - recover + - 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 + type: string + MachineSystemStatusV2N1: + properties: + boot_mode: + description: "The possible values in the boot mode. \n" + enum: + - BIOS + - UEFI_ONLY + - UEFI_SECURE + type: string + disk_status: + description: "The status details of the disk. \n" + items: + $ref: '#/components/schemas/DiskPartitionStatus' + type: array + fips_mode: + description: "The possible values in the FIPs. \n" + enum: + - none + - fips + - non_fips + type: string + hardware_id: + description: "The machine hardware ID. \n" + type: string + id: + description: 'The machine ID. + + ' + type: string + tpm_status: + description: 'The TPM status. + + ' + type: string + trusted_boot: + description: 'The possible values in trusted boot. + + ' + enum: + - PASSED + - FAILED + type: string + required: + - hardware_id + MachineV2N1: + properties: + connected: + description: "The device is connected. True or False. \n" + type: boolean + console_conf_passphrase: + description: "The console password. \n" + type: string + 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. + + ' + type: string + inventory_op: + 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 + is_eval: + description: Is Eval + type: boolean + machine_state: + 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 + type: string + manufacture_id: + description: 'The manufacture ID. + + ' + type: string + model_name: + description: "The model name of the device. \n" + type: string + ordering_info: + description: "The order information. \n" + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + description: Pki Op + renew_state: + 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 + type: string + ship_state: + 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 + suspend_state: + description: 'The suspend 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 + type: string + token: + description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. + + ' + type: string + MachineV2N2: + properties: + connected: + description: "The device is connected. True or False. \n" + type: boolean + console_conf_passphrase: + description: "The console password. \n" + type: string + em_element_id: + description: "The element ID. \n" + type: string + esp_tenant_id: + description: 'The MSP tenant ID. + + ' + type: string + hw_id: + description: 'The hardware ID. + + ' + type: string + id: + description: Id + type: string + image_version: + description: 'The image version. + + ' + type: string + inventory_op: + 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 + is_eval: + description: Is Eval + type: boolean + machine_state: + 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 + type: string + manufacture_id: + description: 'The manufacture ID. + + ' + type: string + model_name: + description: "The model name of the device. \n" + type: string + ordering_info: + description: "The order information. \n" + type: string + owner_tenant_id: + description: "The owner tenant ID. \n" + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + description: Pki Op + renew_state: + 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 + type: string + ship_state: + description: 'The shipping status. + + ' + enum: + - MACHINE_SHIPPED + - MACHINE_SHIPPED_CORRECT_ADDRESS + - MACHINE_SHIPPED_WRONG_ADDRESS + - MACHINE_NOT_SHIPPED + type: string + sl_no: + description: Sl No + type: string + suspend_state: + description: 'The suspend state. + + ' + 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 + type: string + token: + description: 'A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$. + + ' + type: string + MachineV2N3: + properties: + connected: + description: "The device is connected. True or False. \n" + type: boolean + console_conf_passphrase: + description: "The console password. \n" + type: string + em_element_id: + description: "The element ID. \n" + type: string + esp_tenant_id: + description: 'The MSP tenant ID. + + ' + type: string + hw_id: + description: 'The hardware ID. + + ' + type: string + id: + description: Id + type: string + image_version: + description: 'The image version. + + ' + type: string + inventory_op: + 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 + is_eval: + description: Is Eval + type: boolean + machine_state: + 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 + type: string + manufacture_id: + description: 'The manufacture ID. + + ' + type: string + model_name: + description: "The model name of the device. \n" + type: string + ordering_info: + description: "The order information. \n" + type: string + owner_tenant_id: + description: "The owner tenant ID. \n" + type: string + pki_op: + $ref: '#/components/schemas/CAStoreOperation' + description: Pki Op + renew_state: + 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 + type: string + sales_order_number: + description: 'The sales order number. + + ' + type: string + ship_state: + 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 + suspend_state: + description: 'The suspend state. + + ' + 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 + 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: + description: 'The IGMP version. + + ' + enum: + - IGMPV2 + - IGMPV3 + type: string + multicast_enabled: + description: 'Is multicast enabled. True or False. + + ' + type: boolean + NatPool: + properties: + ipv4_ranges: + description: 'The NAT Ipv4 address ranges. Minimum 1 and maximum 4 nat pool + IP ranges can be specified. + + ' + items: + $ref: '#/components/schemas/IPv4Range' + type: array + nat_pool_id: + description: 'The NAT pool ID. + + ' + type: string + PeerInfo: + properties: + hostname: + description: 'The peer hostname. + + ' + type: string + ip_addresses: + description: 'The peer IP addresses. Max size = 4. + + ' + items: + description: Ip Addresses + type: string + type: array + PoeStateS: + properties: + detection_status: + description: 'The PoE detection status. + + ' + type: string + device_type: + description: 'The ION device type. + + ' + type: string + operational_state: + description: "The PoE operational state. \n" + type: string + poe_enabled: + description: "Indicates if PoE is enabled. By default, PoE is disabled.\ + \ \n" + type: boolean + power_classification: + description: "The power classification. \n" + type: string + power_consumed: + description: 'The power consumed. + + ' + format: float + type: number + power_pairs_control_ability: + description: 'Values = True or False. + + ' + type: boolean + power_pairs_state: + description: 'The power pair state. + + ' + type: string + power_priority: + description: 'The power priority. + + ' + type: string + power_usage_threshold: + description: 'The Port Power Usage Alarm Threshold value is between 50 - + 100%.The default threshold is 100% (60W). + + ' + format: int32 + type: integer + Port: + properties: + end: + description: 'The end port range must be between 1 and 65535. + + ' + type: string + start: + description: 'The start port range must be between 1 and 65535. + + ' + type: string + PppoE: + properties: + host_uniq: + description: 'The PPPoE host unique length. It can be null or minimum length + of 2 to maximum length of 254. Length should be in multiples of 2. + + ' + type: string + ip_address_type: + description: 'The PPPoE IP address type. + + ' + enum: + - ipv4 + - ipv6 + - ipv4v6 + type: string + parent: + description: 'The parent value = true. + + ' + type: string + password: + description: 'The PPPoE password. Password is required and can have a max + length of 128 characters. + + ' + type: string + reconnection_delay: + description: 'The reconnection delay time. + + ' + format: int32 + type: integer + service_name: + description: 'The service name. + + ' + type: string + username: + description: 'The PPPoE user name. Username is required and can have a max + length of 128 characters. + + ' + type: string + required: + - ip_address_type + PppoEInterfaceConfig: + properties: + host_uniq: + description: 'The host. + + ' + type: string + ip_address_type: + description: 'IPv4 and IPv6 addresses. + + ' + type: string + password: + description: 'The password for the PPOE interface configuration. + + ' + type: string + reconnection_delay: + description: 'The recoonection delay value. + + ' + format: int32 + type: integer + service_name: + description: 'The name of the service used for the PPPoE configuration. + + ' + type: string + username: + description: 'The username for the PPPoE interface configuration. + + ' + type: string + RecoveryToken: + properties: + hardware_id: + description: Hardware Id + type: string + id: + description: Id + type: string + ion_token: + description: Ion Token + type: string + is_used: + description: Is Used + type: boolean + secret_token: + description: Secret Token + type: string + token_validity_in_hour: + description: Token Validity In Hour + format: int32 + type: integer + valid_till_secs: + description: Valid Till Secs + format: int64 + type: integer + RecoveryTokenScreen: + properties: + id: + description: 'The recovery token ID. + + ' + type: string + token_validity_in_hour: + description: 'The token validity in a hour. + + ' + format: int32 + type: integer + Route: + properties: + destination: + description: 'The route destination. + + ' + type: string + via: + description: 'The via IP address. + + ' + type: string + STPStateS: + properties: + bpdu_guard_enabled: + description: 'BPDU Guard enabled on ports do not receive a BPDU from its + connected devices. When a BPDU Guard enabled port receives BPDU from a + connected device, BPDU Guard disables the port. + + ' + type: boolean + forward_fast_enabled: + description: 'The speed. + + ' + type: boolean + mstp_instance_id: + description: "The MSTP instance ID. \n" + format: int32 + type: integer + port_cost: + description: "The STP port cost is between 1-65535. The STP port cost depends\ + \ on the speed of the port. \n" + format: int32 + type: integer + port_priority: + description: "The STP Port priority is between 0-240. The default value\ + \ is 128, STP port priority is in multiples of 16. \n" + format: int32 + type: integer + port_state: + description: 'The port state. + + ' + type: string + root_guard_enabled: + description: 'Root Guard is enabled on a port-by-port basis, it prevents + a configured port from becoming a root port. Root Guard prevents a downstream + switch from becoming a root bridge in a topology. + + ' + type: boolean + stp_enabled: + description: 'Spanning Tree Protocol (STP) is enabled by default. By default, + the STP type is RSTP. + + ' + type: boolean + SVIStateS: + properties: + stp_designated_cost: + description: "The STP designated cost between 1-65535. \n" + type: integer + stp_designated_mac_address: + description: "The STP designated MAC address. \n" + type: string + stp_designated_port: + description: "The STP designated port. \n" + type: integer + stp_designated_root_mac_address: + description: 'The STP designated root MAC address. + + ' + type: string + SecondaryIPConfig: + properties: + ipv4_address: + description: Ipv4 Address + type: string + scope: + description: "The scope of the secondary IP config. \n" + type: string + ServiceLink: + properties: + gre_config: + $ref: '#/components/schemas/GREConfig' + description: 'The GRE config details. + + ' + ipsec_config: + $ref: '#/components/schemas/IPSECConfig' + description: 'The IPSec config details. + + ' + last_parent: + description: 'The last parent value = true. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + peer: + $ref: '#/components/schemas/PeerInfo' + description: 'The peer information. + + ' + security_service_endpoint_id: + description: 'The security service endpoint ID. + + ' + type: string + service_endpoint_id: + description: 'The service endpoint ID. + + ' + type: string + type: + description: 'The service link type. + + ' + enum: + - IPSEC + - GRE + type: string + required: + - type + ServiceLinkV1: + properties: + ipsec_config: + $ref: '#/components/schemas/IPSECConfig' + description: 'Ipsec Config: Valid ' + last_parent: + description: 'Last Parent: JsonIgnore(value = true) ' + type: string + parent: + description: 'Parent: JsonIgnore(value = true) ' + type: string + peer: + $ref: '#/components/schemas/PeerInfo' + description: 'Peer: Valid ' + service_endpoint_id: + description: Service Endpoint Id + type: string + type: + description: 'Type: ValidateEnum(enumClass = classOf[ServiceLinkType], INVALID_SERVICE_LINK_TYPE, + nullAllowed = false) ' + enum: + - IPSEC + - GRE + type: string + required: + - type + ServiceLinkV2: + properties: + gre_config: + $ref: '#/components/schemas/GREConfig' + description: 'The GRE config details. + + ' + ipsec_config: + $ref: '#/components/schemas/IPSECConfig' + description: 'The IPSec config details. + + ' + last_parent: + description: 'The last parent value = true. + + ' + type: string + parent: + description: 'The parent value = true. + + ' + type: string + peer: + $ref: '#/components/schemas/PeerInfo' + description: 'The peer information. + + ' + service_endpoint_id: + description: "The service endpoint ID. \n" + type: string + type: + description: 'The service link type. + + ' + enum: + - IPSEC + - GRE + type: string + required: + - type + Software: + properties: + location: + description: Location + type: string + version: + description: Version + type: string + SpokeHAConfigV1: + properties: + cluster_id: + description: 'Cluster Id: Required(SPOKEHA_CONFIG_CLUSTER_ID_REQD) ' + type: string + enable: + description: 'Enable: Required(SPOKEHA_CONFIG_ENABLE_REQD) ' + type: boolean + priority: + description: 'Priority: Required(SPOKEHA_CONFIG_PRIORITY_REQD) Range(max + = 254L, SPOKEHA_CONFIG_INVALID_PRIORITY, min = 1L) ' + format: int32 + type: integer + source_interface: + description: 'Source Interface: Required(SPOKEHA_CONFIG_SOURCE_INTERFACE_ID_REQD) ' + type: string + track: + $ref: '#/components/schemas/TrackV1' + description: 'Track: Valid ' + required: + - source_interface + - priority + - enable + - cluster_id + SpokeHAConfigV2: + properties: + cluster_id: + description: "The spoke HA config cluster ID. \n" + type: string + enable: + description: "The spoke HA config enabled. True or False. \n" + type: boolean + priority: + description: "The priority of the spoke HA config. \n" + format: int32 + type: integer + source_interface: + description: 'The spoke HA config source interface ID. + + ' + type: string + track: + $ref: '#/components/schemas/TrackV2' + description: 'Track: Valid ' + required: + - source_interface + - priority + - enable + - cluster_id + StaticARPConfig: + properties: + ipv4_address: + description: 'The static APR IPv4 address. + + ' + type: string + mac_address: + description: 'The MAC address. + + ' + type: string + StormControlConfig: + properties: + broadcast_threshold: + description: 'By default, the broadcast threshold is set to 1000kbps. Enter + a value between 64 -1000000 kbps. + + ' + type: integer + multicast_threshold: + description: 'Multicast threshold value is set between 64-1000000kbps. + + ' + type: integer + unicast_threshold: + description: 'Unknown Unicast threshold value is set between 64-1000000 + kbps. + + ' + type: integer + SubInterface: + properties: + vlan_id: + description: Vlan Id + format: int32 + type: integer + 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 + SwitchConfig: + properties: + default_vlan_id: + description: 'Default VLAN ID is 1. + + ' + format: int32 + type: integer + mstp_enabled: + description: 'The MSTP enabled. True or False. + + ' + type: boolean + stp_aging_timer: + description: "The STP aging Timer between 10 - 1000000 seconds. \ + \ \n" + format: int32 + type: integer + 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: "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: '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: 'The STP Mode is RSTP, default STP mode is RSTP + + ' + enum: + - RSTP + type: string + stp_priority: + description: 'The Priority value is between 0 - 61440, in multiples of 4096. + + ' + format: int32 + type: integer + required: + - stp_mode + SwitchPortConfig: + properties: + access_vlan_id: + description: 'The VLAN access ID. + + ' + type: integer + bpdu_guard_enabled: + description: 'BPDU Guard enabled on ports do not receive a BPDU from its + connected devices. When a BPDU Guard enabled port receives BPDU from a + connected device, BPDU Guard disables the port. + + ' + type: boolean + forward_fast_enabled: + description: 'The speed. + + The attached lan network ID and vlan ID. + + ' + type: boolean + native_vlan_id: + description: 'The VLAN ID. + + ' + type: integer + root_guard_enabled: + description: 'Root Guard is enabled on a port-by-port basis, it prevents + a configured port from becoming a root port. Root Guard prevents a downstream + switch from becoming a root bridge in a topology. + + ' + type: boolean + storm_control_config: + $ref: '#/components/schemas/StormControlConfig' + description: 'Storm control config information. Threshold for traffic rate + limit, the traffic is rate limited for the set threshold value. + + ' + stp_port_cost: + description: 'STP port cost between 1-65535. The STP port cost depends on + the speed of the port. + + ' + format: int32 + type: integer + stp_port_enabled: + description: 'Spanning Tree Protocol (STP) port enabled. + + ' + type: boolean + stp_port_priority: + description: 'STP Port priority is between 0-240. The default value is 128, + STP port priority is in multiples of 16. + + ' + format: int32 + type: integer + trunk_vlans: + description: 'The interface config switch port trunk VLANs. Max trunk VLANs + allowed is 32 and no duplicates are allowed. + + ' + items: + description: Trunk Vlans + type: string + type: array + vlan_mode: + description: 'The VLAN mode. + + ' + enum: + - access + - trunk + type: string + voice_vlan_id: + description: 'The voice VLAN ID. + + ' + type: integer + required: + - vlan_mode + SwitchState: + properties: + bridge_id: + description: 'The switch bridge ID + + ' + type: string + default_vlan_id: + description: 'Default VLAN ID is 1. + + ' + format: int32 + type: integer + designated_bridge_id: + description: "The designated bridge ID. \n" + type: string + last_topology_change: + description: 'Last topology change. + + ' + type: string + max_hops: + description: Max Hops + format: int32 + type: integer + mstp_enabled: + description: 'The MSTP enabled. True or False. + + ' + type: boolean + root_bridge_id: + description: Root Bridge Id + type: string + root_path_cost: + description: Root Path Cost + format: int32 + type: integer + root_port: + description: Root Port + type: string + stp_aging_timer: + description: "The STP aging Timer between 10 - 1000000 seconds. \ + \ \n" + format: int32 + type: integer + 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: "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: '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: 'The STP Mode is RSTP, default STP mode is RSTP + + ' + type: string + stp_priority: + description: 'The Priority value is between 0 - 61440, in multiples of 4096. + + ' + format: int32 + type: integer + TrackInterface: + properties: + interface_id: + description: 'The interface ID + + ' + type: string + reduce_priority: + description: 'Reduce priority of the spoke HA config. + + ' + format: int32 + type: integer + TrackV1: + properties: + interfaces: + description: 'Interfaces: Valid ' + items: + $ref: '#/components/schemas/TrackInterface' + type: array + TrackV2: + properties: + interfaces: + description: 'The details of the interfaces. + + ' + items: + $ref: '#/components/schemas/TrackInterface' + type: array + waninterfaces: + description: 'Waninterfaces: Valid ' + items: + $ref: '#/components/schemas/TrackWANInterface' + type: array + TrackWANInterface: + properties: + reduce_priority: + description: 'Reduce priority of the spoke HA config. + + ' + format: int32 + type: integer + wan_interface_id: + description: 'The WAN interface ID + + ' + type: string + VffInventoryOperation: + enum: + - grant + - return + - revoke + type: string + VffLicense: + properties: + allowed_ions: + description: 'The number of allowed ions. + + ' + format: int32 + type: integer + id: + description: 'The ID of ION. + + ' + type: string + model: + description: 'The model of the ION. + + ' + type: string + required: + - model + VffLicenseQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of vff licenses that match the query + parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of vff licenses deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the vff licenses for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the vff licenses 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 + VffLicenseState: + properties: + deployed_ions: + description: 'The number of deployed IONs. + + ' + format: int32 + type: integer + id: + description: 'The ID of the vff license. + + ' + type: string + VffLicenseStateQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of vff license states that match the + query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of vff license states deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the vff license states for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the vff license states 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 + VffLicenseStateV2: + properties: + deployed_ions: + description: 'The number of deployed IONs. + + ' + format: int32 + type: integer + id: + description: 'The ID of the vff license. + + ' + type: string + source_license_id: + description: 'The source license ID of the IONs. + + ' + type: string + source_tenant_id: + description: 'The source tenant ID. + + ' + type: string + VffLicenseV2: + properties: + allocated_ions: + description: 'The number of allocated IONs in the inventory. + + ' + format: int32 + type: integer + allowed_ions: + description: 'The maximum number of IONs that are allowed. + + ' + format: int32 + type: integer + id: + description: 'The ID of the IONs. + + ' + type: string + model: + description: 'The model of the ION devices. + + ' + type: string + source_license_id: + description: 'The source license ID of the IONs. + + ' + type: string + source_tenant_id: + description: 'The source tenant ID. + + ' + type: string + required: + - model + VffOperationInfo: + properties: + inventory_op: + $ref: '#/components/schemas/VffInventoryOperation' + description: 'The details of the operation in the inventory. + + ' + ions_count: + description: 'The number of IONs in the inventory. + + ' + type: integer + type: object + VffToken: + properties: + id: + description: 'The ID of the vff token. + + ' + type: string + ion_key: + description: 'The ION key. + + ' + type: string + is_expired: + description: 'Is vff token expired. True or False. + + ' + type: boolean + is_multiuse: + description: 'Is the vff token multiuse. True or False. + + ' + type: boolean + is_revoked: + description: "Can the vff token be revoked. True or False. \n" + type: boolean + is_used: + description: 'Is the vff token in use. True or False. + + ' + type: boolean + secret_key: + description: 'The secret key. + + ' + type: string + valid_till_secs: + description: 'The token valid time in seconds. + + ' + format: int64 + type: integer + vfflicense_id: + description: 'The vff license ID. + + ' + type: string + VffTokenQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of vff tokens that match the query parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of vff tokens deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the vff tokens for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "List the vff tokens 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 + VffTokenQueryFilter: + properties: + id: + description: 'The ID of the vff token. + + ' + type: string + ion_key: + description: 'The ION key. + + ' + type: string + is_expired: + description: 'Is vff token expired. True or False. + + ' + type: boolean + is_multiuse: + description: 'Is the vff token multiuse. True or False. + + ' + type: boolean + is_revoked: + description: "Can the vff token be revoked. True or False. \n" + type: boolean + is_used: + description: 'Is the vff token in use. True or False. + + ' + type: boolean + secret_key: + description: 'The secret key. + + ' + type: string + valid_till_secs: + description: 'The token valid time in seconds. + + ' + format: int64 + type: integer + vfflicense_id: + description: 'The vff license ID. + + ' + type: string + VffTokenScreen: + properties: + id: + description: 'The ID of the vff token. + + ' + type: string + ion_key: + description: 'The ION key. + + ' + type: string + is_expired: + description: 'Is vff token expired. True or False. + + ' + type: boolean + is_multiuse: + description: 'Is the vff token multiuse. True or False. + + ' + type: boolean + is_revoked: + description: "Can the vff token be revoked. True or False. \n" + type: boolean + is_used: + description: 'Is the vff token in use. True or False. + + ' + type: boolean + secret_key: + description: 'The secret key. + + ' + type: string + valid_till_secs: + description: 'The token valid time in seconds. + + ' + format: int64 + type: integer + vfflicense_id: + description: 'The vff license ID. + + ' + type: string + VlanConfig: + properties: + element_vlan_unique_id: + description: 'The element VLAN unique ID. + + ' + type: string + mstp_instance: + description: Mstp Instance + format: int32 + type: integer + vlan_id: + description: 'The VLAN ID. + + ' + format: int32 + type: integer + voice_enabled: + description: 'The voice enabled VLAN. + + ' + type: boolean + X509Objects: + properties: + certHolder: + type: object + certificate: + description: Certificate + type: string + is_local_ca_cert_set: + description: Is Local Ca Cert Set + type: boolean + is_remote_ca_cert_set: + description: Is Remote Ca Cert Set + type: boolean + keyPair: + type: object + local_ca_certificate: + description: Local Ca Certificate + type: string + local_ca_certs_set: + description: Local Ca Certs Set + items: + type: object + type: array + passphrase: + description: Passphrase + type: string + private_key: + description: Private Key + type: string + remote_ca_certificate: + description: Remote Ca Certificate + type: string + remote_ca_certs_set: + description: Remote Ca Certs Set + items: + type: object + type: array +info: + contact: {} + description: List of APIs used to manage your device software to upgrade, retrieve + available software images, and upgrade status information. + title: Device Configuration + version: Latest +openapi: 3.0.0 +paths: + /sdwan/v2.0/api/clients/{client_id}/machines: + get: + description: List all the machines of a tenant. + operationId: get-sdwan-v2.0-api-clients-client_id-machines + parameters: + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/MachineV2N2' + type: array + type: object + description: Successful Operation + summary: Get Machines of Tenant (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/clients/{client_id}/machines/query: + post: + description: Query the details of a tenant's client. + operationId: post-sdwan-v2.0-api-clients-client_id-machines-query + parameters: + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Machine' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Machine' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_OPERATION + - code: INVALID_STATE + - code: OPERATION_NOT_ALLOWED + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: NAME_EXCEEDS_LIMIT + - code: DESCRIPTION_EXCEEDS_LIMIT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Tenant's Client (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/clients/{client_id}/machines/{machine_id}: + get: + description: List a specific machine of a tenant. + operationId: get-sdwan-v2.0-api-clients-client_id-machines-machine_id + parameters: + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + - description: The device ID. + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/Machine' + type: array + description: Successful Operation + summary: Get Machine of Tenant (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/clients/{client_id}/machines/{machine_id}/reallocate: + post: + description: Update the device of a tenant. + operationId: post-sdwan-v2.0-api-clients-client_id-machines-machine_id-reallocate + parameters: + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + - description: The device ID. + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Machine' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Machine' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_OPERATION + - code: INVALID_STATE + - code: OPERATION_NOT_ALLOWED + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: NAME_EXCEEDS_LIMIT + - code: DESCRIPTION_EXCEEDS_LIMIT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Tenant Machine (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/elements: + get: + description: List all the elements of a tenant in a site. + operationId: get-sdwan-v2.0-api-elements + responses: + '200': + content: + application/json: + schema: + oneOf: + - allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilter' + type: array + type: object + - allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilter' + type: array + type: object + description: Successful Operation + summary: Get Elements of Tenant in Site (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/elements/query: + post: + description: Query db for elements that match query parameters + operationId: post-sdwan-v2.0-api-elements-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementQueryFilter' + description: Details of the query to be created. + 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: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query db for elements that match query parameters (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/elements/software/state/query: + post: + description: Query the software state for all the tenant's elements. + operationId: post-sdwan-v2.0-api-elements-software-state-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementStateQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementStateQueryFilter' + type: array + type: object + description: Successful Operation + summary: Query Software State for Tenant's Elements (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/elements/status/query: + post: + description: Query the element status objects for a tenant. + operationId: post-sdwan-v2.0-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 + summary: Query Element Status Objects for Tenant (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/elements/{element_id}: + get: + description: Get the element of a tenant. + operationId: get-sdwan-v2.0-api-elements-element_id + 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/Element' + description: Successful Operation + summary: Get Element of Tenant (v2.0) + tags: + - Device Configuration + put: + description: Update element for associations. + operationId: put-sdwan-v2.0-api-elements-element_id + parameters: + - 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/ElementScreen' + description: Details of the element to be updated. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Element' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_BOUND_ERROR + - code: ELEMENT_CONFIG_INVALID_VALUES + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Element for Associations (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/elements/{element_id}/certificate_operations: + post: + description: Start the CIC renewal process for an element device. + operationId: post-sdwan-v2.0-api-elements-element_id-certificate_operations + parameters: + - 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/ElementOperations' + description: Details of the operations on element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementOperations' + description: Successful Operation + summary: CIC Renewal Process for Element Device (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/elements/{element_id}/hardwarebypass: + get: + description: List all the hardware bypasses in an element. + operationId: get-sdwan-v2.0-api-elements-element_id-hardwarebypass + 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/HardwareBypass' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INTERFACE_CONFIG_HWBYPASS_NOT_SUPPORTED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Hardware Bypasses in Element (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/elements/{element_id}/operations: + post: + description: Handle all the operations on an element. + operationId: post-sdwan-v2.0-api-elements-element_id-operations + parameters: + - 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/ElementOperations' + description: Details of the operations on element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementOperations' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: COMMAND_NOT_SUPPORTED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Handle Operations on Element (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/elements/{element_id}/software/state: + get: + description: Get the software upgrade configuration of an element. + operationId: get-sdwan-v2.0-api-elements-element_id-software-state + 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/ElementSoftwareState' + description: Successful Operation + summary: Get Software Upgrade Configuration of Element (v2.0) + tags: + - Device Configuration + put: + description: Upgrade an element. + operationId: put-sdwan-v2.0-api-elements-element_id-software-state + parameters: + - 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/ElementSoftwareStateScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementSoftwareState' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SOFTWARE_CONFIG_INVALID_SCHEDULING + - code: SOFTWARE_CONFIG_SCHEDULED_UPGRADE_NOT_SUPPORTED + - code: SOFTWARE_CONFIG_INVALID_DOWNLOAD_INTERVAL + - code: SOFTWARE_CONFIG_INVALID_UPGRADE_INTERVAL + - code: SOFTWARE_CONFIG_INVALID_DOWNLOAD_TIME + - code: SOFTWARE_CONFIG_INVALID_UPGRADE_TIME + - code: SOFTWARE_CONFIG_INCOMPATIBLE_SCHEDULES + - code: SOFTWARE_CONFIG_INVALID_INTERFACES + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Upgrade an Element (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/elements/{element_id}/software/status: + get: + description: Get the image status. + operationId: get-sdwan-v2.0-api-elements-element_id-software-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/ElementImageStatus' + description: Successful Operation + summary: Get Image Status (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/elements/{element_id}/state: + get: + description: Get the element state. + operationId: get-sdwan-v2.0-api-elements-element_id-state + 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/ElementState' + description: Successful Operation + summary: Get Element State (v2.0) + tags: + - Device Configuration + put: + description: Update the element state. + operationId: put-sdwan-v2.0-api-elements-element_id-state + parameters: + - 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/ElementStateScreen' + description: Update element state + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementState' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_BOUND_ERROR + - code: ELEMENT_CONFIG_INVALID_VALUES + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Element State (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/elements/{element_id}/status: + get: + description: Get the specific element status for a tenant. + operationId: get-sdwan-v2.0-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/ElementStatus' + 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.0) + tags: + - Device Configuration + /sdwan/v2.0/api/machines: + get: + description: Get all the machines of a tenant. + operationId: get-sdwan-v2.0-api-machines + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: MACHINE_UNKNOWN + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Machines of Tenant (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/machines/query: + post: + description: Query a specific machine of a tenant. + operationId: post-sdwan-v2.0-api-machines-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ESP_OPERATION_NOT_ALLOWED + - code: INVALID_OPERATION + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: SELF_ESP_RECEIVE_STOCK_ERROR + - code: INVALID_ESP_CLIENT + - code: MACHINE_UNKNOWN + - code: INVALID_STATE + - code: LICENSE_NOT_FOUND + - code: MACHINE_INACTIVE + - code: MACHINE_DISCONNECTED + - code: PLEASE_RETRY_LATER + - code: CLAIM_ALREADY_IN_PROGRESS + - code: OPERATION_NOT_ALLOWED + - code: INVALID_ESP_MACHINE_STATE + - code: INVALID_ESP_FOR_MACHINE + - code: OPERATION_NOT_ALLOWED_FOR_VFF + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Machine of Tenant (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/machines/{machine_id}: + get: + description: Get the tenant machine. + operationId: get-sdwan-v2.0-api-machines-machine_id + parameters: + - description: The machine ID. + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Machine' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - 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.0) + tags: + - Device Configuration + /sdwan/v2.0/api/machines/{machine_id}/operations: + post: + description: Update the tenant machine. + operationId: post-sdwan-v2.0-api-machines-machine_id-operations + parameters: + - 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/Machine' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Machine' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - 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: Update Tenant Machine (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/admin_state: + put: + description: Update admin state Northbound. + operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-admin_state + 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/Element' + description: Update admin state + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Element' + description: Successful Operation + summary: Update Admin State Northbound (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/application_probe: + get: + description: Get the application probe configuration of an element. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-application_probe + 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/ApplicationProbe' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPLICATION_PROBE_CONFIG_UNSUPPORTED_SWVERSION + - code: APPLICATION_PROBE_CONFIG_NOT_PRESENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Application Probe Configuration (v2.0) + tags: + - Device Configuration + put: + description: Update the application probe configuration of an element. + operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-application_probe + 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/ApplicationProbeScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationProbe' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: APPLICATION_PROBE_CONFIG_UNSUPPORTED_SWVERSION + - code: APPLICATION_PROBE_CONFIG_UNSUPPORTED_ROLE + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: APPLICATION_PROBE_CONFIG_INVALID_SOURCE_INTERFACE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Application Probe Configuration (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/extensions: + get: + description: List all the element level extensions. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-extensions + 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: + oneOf: + - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/ListResponse' + 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 Element Level Extensions (v2.0) + tags: + - Device Configuration + post: + description: Create an element level extension configuration. + operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-extensions + 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/ExtensionScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: SITE_NOT_FOUND + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: INVALID_JSON_INPUT + - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Element Level Extension Configuration (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/extensions/query: + post: + description: Query element level extensions that match query parameters. + operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-extensions-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/ExtensionQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ExtensionQuery' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: SITE_NOT_FOUND + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: INVALID_JSON_INPUT + - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Element Level Extensions (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/extensions/{extension_id}: + delete: + description: Delete a specific extension associated with an element. + operationId: delete-sdwan-v2.0-api-sites-site_id-elements-element_id-extensions-extension_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 extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: EXTENSION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Element Level Extension (v2.0) + tags: + - Device Configuration + get: + description: Get a specific extension associated with an element. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-extensions-extension_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 extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: EXTENSION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Element Level Extension (v2.0) + tags: + - Device Configuration + put: + description: Update an element level extension configuration. + operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-extensions-extension_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 extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExtensionScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_INPUT + - code: EXTENSION_NOT_FOUND + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Element Level Extension (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: + get: + description: List the status of the interface. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-interfaces-interface_id-status + 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/InterfaceState' + description: Successful Operation + summary: Get Interface Status (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/sites/{site_id}/extensions: + get: + description: List all the site level extensions. + operationId: get-sdwan-v2.0-api-sites-site_id-extensions + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + responses: + '200': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/ListResponse' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SITE_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Site Level Extensions (v2.0) + tags: + - Device Configuration + post: + description: Create site level extension configuration. + operationId: post-sdwan-v2.0-api-sites-site_id-extensions + 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/ExtensionScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: SITE_NOT_FOUND + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: INVALID_JSON_INPUT + - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Site Level Extension Configuration (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/sites/{site_id}/extensions/query: + post: + description: Query site level extensions that match query parameters. + operationId: post-sdwan-v2.0-api-sites-site_id-extensions-query + 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/ExtensionQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ExtensionQuery' + type: array + type: object + description: Successful Operation + summary: Query Site Level Extension (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/sites/{site_id}/extensions/{extension_id}: + delete: + description: Delete a specific extension associated with a site. + operationId: delete-sdwan-v2.0-api-sites-site_id-extensions-extension_id + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: EXTENSION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Site Level Extension (v2.0) + tags: + - Device Configuration + get: + description: Get a specific extension associated with a site. + operationId: get-sdwan-v2.0-api-sites-site_id-extensions-extension_id + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: EXTENSION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Site Level Extension (v2.0) + tags: + - Device Configuration + put: + description: Update a specific extension configuration associated with a site. + operationId: put-sdwan-v2.0-api-sites-site_id-extensions-extension_id + parameters: + - description: The site ID. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExtensionScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_INPUT + - code: EXTENSION_NOT_FOUND + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Site Level Extension Configuration (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/vfflicenses: + get: + description: List all the Vff licenses for a tenant. + operationId: get-sdwan-v2.0-api-vfflicenses + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/VffLicense' + type: array + type: object + description: Successful Operation + summary: Get Vff Licenses for Tenant (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/vfflicenses/rquery: + post: + description: Query all the Vff licenses for a tenant. + operationId: post-sdwan-v2.0-api-vfflicenses-rquery + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VffLicenseQuery' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VffLicenseQuery' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_MODEL + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Vff Licenses for Tenant (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/vfflicenses/tokens/query: + post: + description: Query all the tenant Vff license tokens. + operationId: post-sdwan-v2.0-api-vfflicenses-tokens-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VffTokenQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/VffTokenQueryFilter' + type: array + type: object + description: Successful Operation + summary: Query Vff License Tokens (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/vfflicenses/{license_id}: + get: + description: List all the specific Vff licenses for a tenant. + operationId: get-sdwan-v2.0-api-vfflicenses-license_id + parameters: + - 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/VffLicense' + description: Successful Operation + summary: Get Vff Licenses for Tenant (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/vfflicenses/{license_id}/operations: + post: + description: List the vff operations. + operationId: post-sdwan-v2.0-api-vfflicenses-license_id-operations + parameters: + - description: The license ID of the vff. + in: path + name: license_id + required: true + schema: + description: License Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VffOperationInfo' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VffLicenseV2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_CHILD_TENANT + - code: INVALID_VFF_LICENSE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Vff Operation (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/vfflicenses/{license_id}/status: + get: + description: List the status for the Vff license. + operationId: get-sdwan-v2.0-api-vfflicenses-license_id-status + parameters: + - 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/VffLicenseState' + description: Successful Operation + summary: Get Status for Vff License (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/vfflicenses/{license_id}/tokens: + get: + description: List all the tenant Vff license tokens. + operationId: get-sdwan-v2.0-api-vfflicenses-license_id-tokens + parameters: + - description: The license ID. + in: path + name: license_id + required: true + schema: + description: License Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/VffToken' + type: array + type: object + description: Successful Operation + summary: Get Tenant Vff License Tokens (v2.0) + tags: + - Device Configuration + post: + description: Create a tenant Vff license token. + operationId: post-sdwan-v2.0-api-vfflicenses-license_id-tokens + parameters: + - description: The license ID. + in: path + name: license_id + required: true + schema: + description: License Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VffToken' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VffToken' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: TOKEN_CONFIG_INVALID_POST_VALUES + - code: LICENSE_UNKNOWN + - code: ION_MAX_LIMIT + - code: ERROR_IN_TOKEN_GENERATION + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Tenant Vff License Token (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/vfflicenses/{license_id}/tokens/{token_id}: + get: + description: List a specific tenant Vff license token. + operationId: get-sdwan-v2.0-api-vfflicenses-license_id-tokens-token_id + parameters: + - description: The license ID. + in: path + name: license_id + required: true + schema: + description: License Id + type: string + - description: The token ID. + in: path + name: token_id + required: true + schema: + description: Token Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VffToken' + description: Successful Operation + summary: Get Tenant Vff License Token (v2.0) + tags: + - Device Configuration + put: + description: Update a specific tenant Vff license token. + operationId: put-sdwan-v2.0-api-vfflicenses-license_id-tokens-token_id + parameters: + - description: The license ID. + in: path + name: license_id + required: true + schema: + description: License Id + type: string + - description: The token ID. + in: path + name: token_id + required: true + schema: + description: Token Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VffTokenScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VffToken' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: TOKEN_CONFIG_INVALID_PUT_VALUES + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Tenant Vff License Token (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/vfflicensesstatus/rquery: + post: + description: Query to get the license state of the virtual device (vff). + operationId: post-sdwan-v2.0-api-vfflicensesstatus-rquery + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VffLicenseStateQuery' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VffLicenseStateQuery' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_MODEL + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query to Get Vff License State (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/ws/extensions: + get: + description: List all the extensions from NB. + operationId: get-sdwan-v2.0-api-ws-extensions + responses: + '200': + content: + application/json: + schema: + oneOf: + - allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/Extension' + type: array + type: object + - allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ExtensionQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: EXTENSION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Extensions from NB (v2.0) + tags: + - Device Configuration + post: + description: Create an extension configuration. + operationId: post-sdwan-v2.0-api-ws-extensions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: EXTENSION_NAME_REQD + - code: INVALID_EXTENSION_CONF + - code: INVALID_EXTENSION_NAMESPACE + - code: EXTENSION_NAMESPACE_REQD + - code: INVALID_EXTENSION_NAME + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Extension Configuration (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/ws/extensions/query: + post: + description: Query the DB for limit number of tenant extensions that match the + query params. + operationId: post-sdwan-v2.0-api-ws-extensions-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExtensionQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ExtensionQueryFilter' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_REQUEST_ERROR_0001 + - code: INVALID_REQUEST_DUPLICATE_KEY + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Tenant Extensions (v2.0) + tags: + - Device Configuration + /sdwan/v2.0/api/ws/extensions/{extension_id}: + delete: + description: Delete a specific extension configuration. + operationId: delete-sdwan-v2.0-api-ws-extensions-extension_id + parameters: + - description: The extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: EXTENSION_NAME_REQD + - code: INVALID_EXTENSION_CONF + - code: INVALID_EXTENSION_NAMESPACE + - code: EXTENSION_NAMESPACE_REQD + - code: INVALID_EXTENSION_NAME + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Extensions Configuration (v2.0) + tags: + - Device Configuration + get: + description: Get a specific extension configuration from the NB. + operationId: get-sdwan-v2.0-api-ws-extensions-extension_id + parameters: + - description: The extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + summary: Get Extensions Configuration from NB (v2.0) + tags: + - Device Configuration + put: + description: Update a specific extension configuration. + operationId: put-sdwan-v2.0-api-ws-extensions-extension_id + parameters: + - description: The extension ID. + in: path + name: extension_id + required: true + schema: + description: Extension Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: EXTENSION_NAME_REQD + - code: INVALID_EXTENSION_CONF + - code: INVALID_EXTENSION_NAMESPACE + - code: EXTENSION_NAMESPACE_REQD + - code: INVALID_EXTENSION_NAME + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Extensions Configuration (v2.0) + tags: + - Device Configuration + /sdwan/v2.1/api/clients/{client_id}/machines: + get: + description: Get all the machines allocated by MSP to a client tenant. + operationId: get-sdwan-v2.1-api-clients-client_id-machines + parameters: + - description: The tenant ID of the client tenant of MSP. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + type: object + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: INVALID_ESP_CLIENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Machines of Tenant (v2.1) + tags: + - Device Configuration + /sdwan/v2.1/api/clients/{client_id}/machines/query: + post: + description: Query all the machines allocated by MSP to a client tenant. + operationId: post-sdwan-v2.1-api-clients-client_id-machines-query + parameters: + - description: The tenant ID of the client tenant of MSP. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + type: object + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_ESP_CLIENT + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Tenant's Client (v2.1) + tags: + - Device Configuration + /sdwan/v2.1/api/clients/{client_id}/machines/{machine_id}: + get: + description: Get a specific machine allocated by MSP to a client tenant. + operationId: get-sdwan-v2.1-api-clients-client_id-machines-machine_id + parameters: + - description: The tenant ID of the client tenant of MSP. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + - description: The device ID. + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: INVALID_ESP_CLIENT + - code: MACHINE_UNKNOWN + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Machine of Tenant (v2.1) + tags: + - Device Configuration + /sdwan/v2.1/api/clients/{client_id}/machines/{machine_id}/reallocate: + post: + description: Reallocate a specific machine from one client tenant to another, + when both client tenants are clients of the same MSP. + operationId: post-sdwan-v2.1-api-clients-client_id-machines-machine_id-reallocate + parameters: + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + - description: The device ID. + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineInfo' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_ESP_CLIENT + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: MACHINE_UNKNOWN + - code: OPERATION_NOT_ALLOWED + - code: INVALID_OPERATION + - code: INVALID_STATE + description: If the machine is not in to_be_returned state or + allocated_to_esp states, use /operations API to move it to to_be_returned + (return operation) or allocated_to_esp (esp_received stock operation) + state, before attempting to reallocate the machine to another + client tenant. + - code: MACHINE_DELETE_DEFAULT_REGION + - code: INVALID_MACHINE_REGION + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Reallocate Client Tenant Machine (v2.1) + tags: + - Device Configuration + /sdwan/v2.1/api/elements: + get: + description: List all the elements of a tenant in a site. + operationId: get-sdwan-v2.1-api-elements + responses: + '200': + content: + application/json: + schema: + oneOf: + - allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilterV2N1' + type: array + type: object + - allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/Element' + type: array + type: object + description: Successful Operation + summary: Get Elements of Tenant in Site (v2.1) + tags: + - Device Configuration + /sdwan/v2.1/api/elements/query: + post: + description: Query the DB for elements that match the query parameters. + operationId: post-sdwan-v2.1-api-elements-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementQuery' + description: Details of the query to be created. + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilterV2N1' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_JSON + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_CLAIMED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Elements (v2.1) + 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}: + get: + description: Get the element of a tenant. + operationId: get-sdwan-v2.1-api-elements-element_id + 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/ElementV2N1' + description: Successful Operation + summary: Get Element of Tenant (v2.1) + tags: + - Device Configuration + put: + description: Update associations and elements of a tenant. + operationId: put-sdwan-v2.1-api-elements-element_id + parameters: + - 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/ElementScreenV2N1' + description: Details of the element to be updated. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_BOUND_ERROR + - code: ELEMENT_CONFIG_INVALID_VALUES + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Element of 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. + operationId: post-sdwan-v2.1-api-elements-element_id-fips_mode_change_operations + parameters: + - 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/ElementOperations' + description: Details of the operations on element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementOperations' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: FIPS_MODE_INVALID_OPERATION + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_CONNECTED + - code: FIPS_MODE_ELEMENT_ALREADY_IN_REQUESTED_MODE + - code: FIPS_MODE_MODEL_NOT_SUPPORTED + - code: FIPS_MODE_FORBIDDEN_INVALID_STATE + - code: FIPS_MODE_CHANGE_NOT_SUPPORTED + - code: FIPS_MODE_PLEASE_RETRY_LATER + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Change Mode of Element from FIPS to Non-FIPS (v2.1) + tags: + - Device Configuration + /sdwan/v2.1/api/elements/{element_id}/software/status: + get: + description: List all the software upgrade status (up to 5) started by the tenant + user. + operationId: get-sdwan-v2.1-api-elements-element_id-software-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: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementImageStatusV2N1' + type: array + type: object + description: Successful Operation + 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: + get: + description: Get all the machines of a tenant. + operationId: get-sdwan-v2.1-api-machines + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/MachineV2N1' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '404': + description: Machines not found + summary: Get Machines of Tenant (v2.1) + tags: + - Device Configuration + /sdwan/v2.1/api/machines/query: + post: + description: Query a specific machine of a tenant. + operationId: post-sdwan-v2.1-api-machines-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/MachineQueryFilterV2N1' + 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 Machine of Tenant (v2.1) + tags: + - Device Configuration + /sdwan/v2.1/api/machines/{machine_id}: + get: + description: Get a specific machine of a tenant. + operationId: get-sdwan-v2.1-api-machines-machine_id + parameters: + - description: The machine ID. + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: MACHINE_UNKNOWN + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Tenant Machine (v2.1) + tags: + - Device Configuration + /sdwan/v2.1/api/machines/{machine_id}/machinesystemstatus: + get: + description: Get the machine system status for a tenant. + operationId: get-sdwan-v2.1-api-machines-machine_id-machinesystemstatus + parameters: + - description: The machine ID. + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineSystemStatusV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: MACHINE_UNKNOWN + - code: MACHINE_STATUS_UNKNOWN + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Machine System Status (v2.1) + tags: + - Device Configuration + /sdwan/v2.1/api/machines/{machine_id}/operations: + post: + description: Update a specific machine of a tenant. + operationId: post-sdwan-v2.1-api-machines-machine_id-operations + parameters: + - 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/MachineInfo' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ESP_OPERATION_NOT_ALLOWED + - code: INVALID_OPERATION + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: SELF_ESP_RECEIVE_STOCK_ERROR + - code: INVALID_ESP_CLIENT + - code: MACHINE_UNKNOWN + - code: INVALID_STATE + - code: LICENSE_NOT_FOUND + - code: MACHINE_INACTIVE + - code: MACHINE_DISCONNECTED + - code: PLEASE_RETRY_LATER + - code: CLAIM_ALREADY_IN_PROGRESS + - code: OPERATION_NOT_ALLOWED + - code: INVALID_ESP_MACHINE_STATE + - code: INVALID_ESP_FOR_MACHINE + - code: OPERATION_NOT_ALLOWED_FOR_VFF + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Tenant Machine (v2.1) + tags: + - Device Configuration + /sdwan/v2.1/api/machines/{machine_id}/recovery_tokens: + get: + description: Get the recovery token for a machine. + operationId: get-sdwan-v2.1-api-machines-machine_id-recovery_tokens + parameters: + - description: The machine ID. + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RecoveryToken' + description: Successful Operation + summary: Get Recovery Token for Machine (v2.1) + tags: + - Device Configuration + post: + description: Create a recovery token for the FIPs change mode. + operationId: post-sdwan-v2.1-api-machines-machine_id-recovery_tokens + parameters: + - 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/RecoveryTokenScreen' + description: Details of the recovery token for the element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RecoveryToken' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: MACHINE_NOT_FOUND + - code: FIPS_MODE_ERROR_IN_TOKEN_GENERATION + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Recovery Token for FIPs (v2.1) + tags: + - Device Configuration + /sdwan/v2.1/api/machines/{machine_id}/recovery_tokens/{token_id}: + put: + description: Update Recovery Token for Fips change mode + operationId: put-sdwan-v2.1-api-machines-machine_id-recovery_tokens-token_id + parameters: + - description: Machine Id + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + - description: Token Id + in: path + name: token_id + required: true + schema: + description: Token Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RecoveryTokenScreen' + description: Details of the recovery token for the element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RecoveryToken' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: MACHINE_NOT_FOUND + - code: TOKEN_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Recovery Token for Fips change mode (v2.1) + tags: + - Device Configuration + /sdwan/v2.1/api/software/current_status/query: + post: + description: Get the current image status of all the elements. + operationId: post-sdwan-v2.1-api-software-current_status-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementImageStatusQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementImageStatusQueryFilterV2N1' + type: array + type: object + description: Successful Operation + summary: Get Image Status of Element (v2.1) + tags: + - Device Configuration + /sdwan/v2.1/api/software/status/query: + post: + description: Query the software upgrade status of all the tenant elements. + operationId: post-sdwan-v2.1-api-software-status-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementImageStatusQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementImageStatusQueryFilterV2N1' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Software Upgrade Status (v2.1) + tags: + - Device Configuration + /sdwan/v2.1/api/vfflicenses: + get: + description: List all the Vff licenses for a tenant. + operationId: get-sdwan-v2.1-api-vfflicenses + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/VffLicenseV2' + type: array + type: object + description: Successful Operation + summary: Get Vff Licenses for Tenant (v2.1) + tags: + - Device Configuration + /sdwan/v2.1/api/vfflicenses/{license_id}: + get: + description: List all the specific Vff licenses for a tenant. + operationId: get-sdwan-v2.1-api-vfflicenses-license_id + parameters: + - 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/VffLicenseV2' + description: Successful Operation + summary: Get Vff Licenses for Tenant (v2.1) + tags: + - Device Configuration + /sdwan/v2.1/api/vfflicenses/{license_id}/status: + get: + description: List the status for the Vff license. + operationId: get-sdwan-v2.1-api-vfflicenses-license_id-status + parameters: + - 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 + /sdwan/v2.2/api/clients/{client_id}/machines: + get: + description: List all the machines of a tenant. + operationId: get-sdwan-v2.2-api-clients-client_id-machines + parameters: + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + type: object + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: INVALID_ESP_CLIENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Machines of Tenant (v2.2) + tags: + - Device Configuration + /sdwan/v2.2/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 + parameters: + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + type: object + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_ESP_CLIENT + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Tenant's Client (v2.2) + tags: + - Device Configuration + /sdwan/v2.2/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 + parameters: + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + - description: The device ID. + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: INVALID_ESP_CLIENT + - code: MACHINE_UNKNOWN + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Machine of Tenant (v2.2) + tags: + - Device Configuration + /sdwan/v2.2/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 + parameters: + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + - description: The device ID. + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineInfoV2N2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_ESP_CLIENT + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: MACHINE_UNKNOWN + - code: OPERATION_NOT_ALLOWED + - code: INVALID_OPERATION + - code: INVALID_STATE + description: If the machine is not in to_be_returned state or + allocated_to_esp states, use /operations API to move it to to_be_returned + (return operation) or allocated_to_esp (esp_received stock operation) + state, before attempting to reallocate the machine to another + client tenant. + - code: MACHINE_DELETE_DEFAULT_REGION + - code: INVALID_MACHINE_REGION + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Tenant Machine (v2.2) + tags: + - Device Configuration + /sdwan/v2.2/api/elements: + get: + description: List all the elements of a tenant in a site. + operationId: get-sdwan-v2.2-api-elements + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementV2N2' + type: array + type: object + description: Successful Operation + summary: Get Elements of Tenant in Site (v2.2) + tags: + - Device Configuration + /sdwan/v2.2/api/elements/query: + post: + description: Query the DB for elements that match the query parameters. + operationId: post-sdwan-v2.2-api-elements-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementQuery' + description: Details of the query to be created. + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilterV2N2' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_JSON + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_CLAIMED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Elements (v2.2) + tags: + - Device Configuration + /sdwan/v2.2/api/elements/{element_id}: + get: + description: Get the element of a tenant. + operationId: get-sdwan-v2.2-api-elements-element_id + 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/ElementV2N2' + description: Successful Operation + summary: Get Element of Tenant (v2.2) + tags: + - Device Configuration + put: + description: Update element for associations. + operationId: put-sdwan-v2.2-api-elements-element_id + parameters: + - 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/ElementScreenV2N2' + description: Details of the element to be updated. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_BOUND_ERROR + - code: ELEMENT_HA_CONFIG_NOT_SUPPORTED + - code: ELEMENT_CONFIG_INVALID_VALUES + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Element for Associations (v2.2) + tags: + - Device Configuration + /sdwan/v2.2/api/machines: + get: + description: Get all the machines of a tenant. + operationId: get-sdwan-v2.2-api-machines + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/MachineV2N2' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '404': + description: Machines not found + summary: Get Machines of Tenant (v2.2) + tags: + - Device Configuration + /sdwan/v2.2/api/machines/query: + post: + description: Query the machines of a tenant. + operationId: post-sdwan-v2.2-api-machines-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/MachineQueryFilterV2N2' + 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 Machine of Tenant (v2.2) + tags: + - Device Configuration + /sdwan/v2.2/api/machines/{machine_id}: + get: + description: Get a specific machine of a tenant. + operationId: get-sdwan-v2.2-api-machines-machine_id + parameters: + - description: The machine ID. + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: MACHINE_UNKNOWN + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Tenant Machine (v2.2) + tags: + - Device Configuration + /sdwan/v2.2/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 + parameters: + - 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/MachineInfoV2N2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ESP_OPERATION_NOT_ALLOWED + - code: INVALID_OPERATION + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: SELF_ESP_RECEIVE_STOCK_ERROR + - code: INVALID_ESP_CLIENT + - code: MACHINE_UNKNOWN + - code: INVALID_STATE + - code: LICENSE_NOT_FOUND + - code: MACHINE_INACTIVE + - code: MACHINE_DISCONNECTED + - code: PLEASE_RETRY_LATER + - code: CLAIM_ALREADY_IN_PROGRESS + - code: OPERATION_NOT_ALLOWED + - code: INVALID_ESP_MACHINE_STATE + - code: INVALID_ESP_FOR_MACHINE + - code: OPERATION_NOT_ALLOWED_FOR_VFF + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Tenant Machine (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.3-api-clients-client_id-machines + parameters: + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + type: object + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: INVALID_ESP_CLIENT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Machines of Tenant (v2.3) + tags: + - Device Configuration + /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.3-api-clients-client_id-machines-query + parameters: + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + type: object + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_ESP_CLIENT + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Tenant's Client (v2.3) + tags: + - Device Configuration + /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.3-api-clients-client_id-machines-machine_id + parameters: + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + - description: The device ID. + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: INVALID_ESP_CLIENT + - code: MACHINE_UNKNOWN + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Machine of Tenant (v2.3) + tags: + - Device Configuration + /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.3-api-clients-client_id-machines-machine_id-reallocate + parameters: + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + - description: The device ID. + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineInfoV2N3' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_ESP_CLIENT + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: MACHINE_UNKNOWN + - code: OPERATION_NOT_ALLOWED + - code: INVALID_OPERATION + - code: INVALID_STATE + description: If the machine is not in to_be_returned state or + allocated_to_esp states, use /operations API to move it to to_be_returned + (return operation) or allocated_to_esp (esp_received stock operation) + state, before attempting to reallocate the machine to another + client tenant. + - code: MACHINE_DELETE_DEFAULT_REGION + - code: INVALID_MACHINE_REGION + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Tenant Machine (v2.3) + tags: + - Device Configuration + /sdwan/v2.3/api/elements: + get: + description: List all the elements of a tenant in a site. + operationId: get-sdwan-v2.3-api-elements + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementV2N3' + type: array + type: object + description: Successful Operation + summary: Get Elements of Tenant in Site (v2.3) + tags: + - Device Configuration + /sdwan/v2.3/api/elements/query: + post: + description: Query the DB for elements that match the query parameters. + operationId: post-sdwan-v2.3-api-elements-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/ElementQueryFilterV2N3' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_JSON + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_CLAIMED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Elements (v2.3) + tags: + - Device Configuration + /sdwan/v2.3/api/elements/{element_id}: + get: + description: Get the element of a tenant. + operationId: get-sdwan-v2.3-api-elements-element_id + 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/ElementV2N3' + description: Successful Operation + summary: Get Element of Tenant (v2.3) + tags: + - Device Configuration + put: + description: Update element for associations. + operationId: put-sdwan-v2.3-api-elements-element_id + parameters: + - 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/ElementScreenV2N3' + description: Details of the element to be updated. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_BOUND_ERROR + - code: ELEMENT_CONFIG_INVALID_VALUES + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Element for Associations (v2.3) + tags: + - Device Configuration + /sdwan/v2.3/api/machines: + get: + description: Get all the machines of a tenant. + operationId: get-sdwan-v2.3-api-machines + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/MachineV2N3' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '404': + description: Machines not found + summary: Get Machines of Tenant (v2.3) + tags: + - Device Configuration + /sdwan/v2.3/api/machines/query: + post: + description: Query the machines of a tenant. + operationId: post-sdwan-v2.3-api-machines-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/MachineQueryFilterV2N3' + 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 Machine of Tenant (v2.3) + tags: + - Device Configuration + /sdwan/v2.3/api/machines/{machine_id}: + get: + description: Get a specific machine of a tenant. + operationId: get-sdwan-v2.3-api-machines-machine_id + parameters: + - description: The machine ID. + in: path + name: machine_id + required: true + schema: + description: Machine Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: MACHINE_UNKNOWN + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Tenant Machine (v2.3) + tags: + - Device Configuration + /sdwan/v2.3/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 + parameters: + - 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/MachineInfoV2N3' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MachineV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ESP_OPERATION_NOT_ALLOWED + - code: INVALID_OPERATION + - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: SELF_ESP_RECEIVE_STOCK_ERROR + - code: INVALID_ESP_CLIENT + - code: MACHINE_UNKNOWN + - code: INVALID_STATE + - code: LICENSE_NOT_FOUND + - code: MACHINE_INACTIVE + - code: MACHINE_DISCONNECTED + - code: PLEASE_RETRY_LATER + - code: CLAIM_ALREADY_IN_PROGRESS + - code: OPERATION_NOT_ALLOWED + - code: INVALID_ESP_MACHINE_STATE + - code: INVALID_ESP_FOR_MACHINE + - code: OPERATION_NOT_ALLOWED_FOR_VFF + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Tenant Machine (v2.3) + tags: + - Device Configuration + /sdwan/v2.4/api/elements: + get: + description: List all the elements of a tenant in a site. + operationId: get-sdwan-v2.4-api-elements + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementV2N4' + 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: Get Elements of Tenant in Site (v2.4) + tags: + - Device Configuration + /sdwan/v2.4/api/elements/query: + post: + description: Query the DB for elements that match the query parameters. + operationId: post-sdwan-v2.4-api-elements-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementQuery' + description: Queries to the element + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilterV2N4' + 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 Elements (v2.4) + tags: + - Device Configuration + /sdwan/v2.4/api/elements/{element_id}: + get: + description: Get the element of a tenant. + operationId: get-sdwan-v2.4-api-elements-element_id + 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/ElementV2N4' + description: Successful Operation + summary: Get Element of Tenant (v2.4) + tags: + - Device Configuration + put: + description: Update element for associations. + operationId: put-sdwan-v2.4-api-elements-element_id + parameters: + - 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/ElementScreenV2N4' + description: Update to the element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV2N4' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_JSON + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_CLAIMED + - code: SITE_NOT_FOUND + - code: ELEMENT_BOUND_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Element for Associations (v2.4) + tags: + - Device Configuration + /sdwan/v2.5/api/elements: + get: + description: List all the elements of a tenant in a site. + operationId: get-sdwan-v2.5-api-elements + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementV2N5' + type: array + type: object + description: Successful Operation + summary: Get Elements of Tenant in Site (v2.5) + tags: + - Device Configuration + /sdwan/v2.5/api/elements/query: + post: + description: Query the DB for elements that match the query parameters. + operationId: post-sdwan-v2.5-api-elements-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementQuery' + description: Queries to the element + responses: + '200': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilterV2N5' + type: array + type: object + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementAggregateQueryFilterV2N5' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + - code: UNSUPPOPRTED_REQUEST_PARAMETERS + - code: INVALID_AGGREGATE_QUERY_PARAMS + - code: INVALID_AGGREGATE_QUERY_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '500': + content: + application/json: + example: + value: + _error: + - code: INVALID_SUBJECT_DATA + - code: SERVICE_UNAVAILABLE + schema: + $ref: '#/components/schemas/Error' + description: Internal Server Error + summary: Query DB for Elements (v2.5) + tags: + - Device Configuration + /sdwan/v2.5/api/elements/{element_id}: + get: + description: Get the element of a tenant. + operationId: get-sdwan-v2.5-api-elements-element_id + 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/ElementV2N5' + description: Successful Operation + summary: Get Element of Tenant (v2.5) + tags: + - Device Configuration + put: + description: Update element for associations. + operationId: put-sdwan-v2.5-api-elements-element_id + parameters: + - 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/ElementScreenV2N5' + description: Update to the element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV2N5' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_JSON + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_CLAIMED + - code: SITE_NOT_FOUND + - code: ELEMENT_BOUND_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Element for Associations (v2.5) + tags: + - Device Configuration + /sdwan/v2.6/api/elements: + get: + description: List all the elements of a tenant in a site. + operationId: get-sdwan-v2.6-api-elements + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementV2N6' + 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 Elements of Tenant in Site (v2.6) + tags: + - Device Configuration + /sdwan/v2.6/api/elements/query: + post: + description: Query the DB for elements that match the query parameters. + operationId: post-sdwan-v2.6-api-elements-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementQuery' + description: Queries to the element + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilterV2N6' + 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 Elements (v2.6) + tags: + - Device Configuration + /sdwan/v2.6/api/elements/{element_id}: + get: + description: Get the element of a tenant. + operationId: get-sdwan-v2.6-api-elements-element_id + 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/ElementV2N6' + 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.6) + tags: + - Device Configuration + put: + description: Update element for associations. + operationId: put-sdwan-v2.6-api-elements-element_id + parameters: + - 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/ElementScreenV2N6' + description: Update to the element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV2N6' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_JSON + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_CLAIMED + - code: SITE_NOT_FOUND + - code: ELEMENT_BOUND_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Element for Associations (v2.6) + tags: + - Device Configuration + /sdwan/v2.7/api/elements: + get: + description: Get the element of a tenant. + operationId: get-sdwan-v2.7-api-elements + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementV2N7' + 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) + tags: + - Device Configuration + /sdwan/v2.7/api/elements/query: + post: + description: Query the DB for elements that match the query parameters. + operationId: post-sdwan-v2.7-api-elements-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementQuery' + description: Queries to the element + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilterV2N7' + 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 Elements (v2.7) + tags: + - Device Configuration + /sdwan/v2.7/api/elements/{element_id}: + get: + description: Get the element of a tenant. + operationId: get-sdwan-v2.7-api-elements-element_id + 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/ElementV2N7' + 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) + tags: + - Device Configuration + put: + description: Update element for associations. + operationId: put-sdwan-v2.7-api-elements-element_id + parameters: + - 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/ElementScreenV2N7' + description: Update to the element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV2N7' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_JSON + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_CLAIMED + - code: SITE_NOT_FOUND + - code: ELEMENT_BOUND_ERROR + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Element for Associations (v2.7) + tags: + - Device Configuration + /sdwan/v3.0/api/elements: + get: + description: Get the element of a tenant. + operationId: get-sdwan-v3.0-api-elements + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementV3' + type: array + type: object + description: Successful Operation + summary: Get Element of Tenant (v3.0) + tags: + - Device Configuration + /sdwan/v3.0/api/elements/query: + post: + description: Query the DB for elements that match the query parameters. + operationId: post-sdwan-v3.0-api-elements-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ElementQuery' + description: Queries to the element + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementQueryFilterV3' + 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 Elements (v3.0) + tags: + - Device Configuration + /sdwan/v3.0/api/elements/{element_id}: + get: + description: Get the element of a tenant. + operationId: get-sdwan-v3.0-api-elements-element_id + 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/ElementV3' + description: Successful Operation + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Element not found + summary: Get Element of Tenant (v3.0) + tags: + - Device Configuration + put: + description: Update element for associations. + operationId: put-sdwan-v3.0-api-elements-element_id + parameters: + - 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/ElementScreenV3' + description: Update to the element + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementScreenV3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - 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: 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 + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Element for Associations (v3.0) + tags: + - Device Configuration + /sdwan/v3.0/api/machines/rquery: + post: + description: Query and get all MSP machines across regions. + operationId: post-sdwan-v3.0-api-machines-rquery + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineQuery' + description: Details of machine query + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/MachineQuery' + type: array + type: object + description: Successful Operation + summary: Query MSP Machines across Regions (v3.0) + tags: + - Device Configuration + /sdwan/v3.0/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: + get: + description: Get interface status. + operationId: get-sdwan-v3.0-api-sites-site_id-elements-element_id-interfaces-interface_id-status + 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 - remote_ca_certificate: - description: Remote Ca Certificate + - description: The interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string - remote_ca_certs_set: - description: Remote Ca Certs Set - items: - type: object - type: array -info: - contact: {} - description: List of APIs used to manage your device software to upgrade, retrieve - available software images, and upgrade status information. - title: Device Configuration - version: Latest -openapi: 3.0.0 -paths: - /sdwan/v2.0/api/elements/software/state/query: + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceState' + description: Successful Operation + summary: Get Interface Status (v3.0) + tags: + - Device Configuration + /sdwan/v3.1/api/machines/rquery: post: - description: Query the software state for all the tenant's elements. - operationId: post-sdwan-v2.0-api-elements-software-state-query + description: Query and get all MSP machines across regions. + operationId: post-sdwan-v3.1-api-machines-rquery requestBody: content: application/json: schema: - $ref: '#/components/schemas/ElementStateQuery' + $ref: '#/components/schemas/MachineQuery' + description: Details of machine query responses: '200': content: @@ -8515,18 +20734,25 @@ paths: - properties: items: items: - $ref: '#/components/schemas/ElementStateQueryFilter' + $ref: '#/components/schemas/MachineQuery' type: array type: object description: Successful Operation - summary: Query Software State for Tenant's Elements (v2.0) + summary: Query MSP Machines across Regions (v3.1) tags: - Device Configuration - /sdwan/v2.0/api/elements/{element_id}/certificate_operations: - post: - description: Start the CIC renewal process for an element device. - operationId: post-sdwan-v2.0-api-elements-element_id-certificate_operations + /sdwan/v3.1/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: + get: + description: Get interface status. + operationId: get-sdwan-v3.1-api-sites-site_id-elements-element_id-interfaces-interface_id-status 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 @@ -8534,27 +20760,241 @@ paths: 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/InterfaceStateV3N1' + description: Successful Operation + summary: Get Interface Status (v3.1) + tags: + - Device Configuration + /sdwan/v3.2/api/machines/rquery: + post: + description: Query and get all MSP machines across regions. + operationId: post-sdwan-v3.2-api-machines-rquery requestBody: content: application/json: schema: - $ref: '#/components/schemas/ElementOperations' - description: Details of the operations on element + $ref: '#/components/schemas/MachineQuery' + description: Details of machine query responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementOperations' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/MachineQuery' + type: array + type: object description: Successful Operation - summary: CIC Renewal Process for Element Device (v2.0) + summary: Query MSP Machines across Regions (v3.2) tags: - Device Configuration - /sdwan/v2.0/api/elements/{element_id}/hardwarebypass: + /sdwan/v3.2/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: get: - description: List all the hardware bypasses in an element. - operationId: get-sdwan-v2.0-api-elements-element_id-hardwarebypass + description: Get interface status. + operationId: get-sdwan-v3.2-api-sites-site_id-elements-element_id-interfaces-interface_id-status + 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/InterfaceStateV3N2' + description: Successful Operation + summary: Get Interface Status (v3.2) + tags: + - Device Configuration + /sdwan/v3.3/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: + get: + description: Get element interface status. + operationId: get-sdwan-v3.3-api-sites-site_id-elements-element_id-interfaces-interface_id-status + 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/InterfaceStateV3N3' + description: Successful Operation + summary: Get Element Interface Status (v3.3) + tags: + - Device Configuration + /sdwan/v3.4/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 + 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/InterfaceStateV3N4' + description: Successful Operation + summary: Get Interface Status (v3.4) + tags: + - Device Configuration + /sdwan/v3.5/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 + 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/InterfaceStateV3N5' + description: Successful Operation + summary: Get Interface Status (v3.5) + tags: + - Device Configuration + /sdwan/v4.0/api/sites/{site_id}/elements/{element_id}/interfaces: + get: + description: Get all element interfaces. + operationId: get-sdwan-v4.0-api-sites-site_id-elements-element_id-interfaces 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: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/InterfaceV4N1' + type: array + type: object + description: Successful Operation + summary: Get Element Interfaces (v4.0) + tags: + - Device Configuration + post: + description: Create an element logical interface. + operationId: post-sdwan-v4.0-api-sites-site_id-elements-element_id-interfaces + 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 @@ -8562,12 +21002,17 @@ paths: schema: description: Element Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceScreenV4N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HardwareBypass' + $ref: '#/components/schemas/InterfaceV4N1' description: Successful Operation '400': content: @@ -8575,18 +21020,29 @@ paths: example: value: _error: - - code: INTERFACE_CONFIG_HWBYPASS_NOT_SUPPORTED + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Hardware Bypasses in Element (v2.0) + summary: Create Element Logical Interface (v4.0) tags: - Device Configuration - /sdwan/v2.0/api/elements/{element_id}/operations: - post: - description: Handle all the operations on an element. - operationId: post-sdwan-v2.0-api-elements-element_id-operations + /sdwan/v4.0/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an element interface. + operationId: delete-sdwan-v4.0-api-sites-site_id-elements-element_id-interfaces-interface_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 @@ -8594,18 +21050,19 @@ paths: schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ElementOperations' - description: Details of the operations on element + - 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/ElementOperations' + $ref: '#/components/schemas/InterfaceV4N1' description: Successful Operation '400': content: @@ -8613,19 +21070,24 @@ paths: example: value: _error: - - code: ELEMENT_NOT_FOUND - - code: COMMAND_NOT_SUPPORTED + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Handle Operations on Element (v2.0) + summary: Delete Element Interface (v4.0) tags: - Device Configuration - /sdwan/v2.0/api/elements/{element_id}/software/state: get: - description: Get the software upgrade configuration of an element. - operationId: get-sdwan-v2.0-api-elements-element_id-software-state + description: Get element interface details. + operationId: get-sdwan-v4.0-api-sites-site_id-elements-element_id-interfaces-interface_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 @@ -8633,20 +21095,34 @@ paths: 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/ElementSoftwareState' + $ref: '#/components/schemas/InterfaceV4N1' description: Successful Operation - summary: Get Software Upgrade Configuration of Element (v2.0) + summary: Get Element Interface Details(v4.0) tags: - Device Configuration put: - description: Upgrade an element. - operationId: put-sdwan-v2.0-api-elements-element_id-software-state + description: Provision an element interface. + operationId: put-sdwan-v4.0-api-sites-site_id-elements-element_id-interfaces-interface_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 @@ -8654,17 +21130,24 @@ paths: schema: description: Element Id type: string + - description: The interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ElementSoftwareStateScreen' + $ref: '#/components/schemas/InterfaceScreenV4N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementSoftwareState' + $ref: '#/components/schemas/InterfaceV4N1' description: Successful Operation '400': content: @@ -8672,49 +21155,33 @@ paths: example: value: _error: - - code: SOFTWARE_CONFIG_INVALID_SCHEDULING - - code: SOFTWARE_CONFIG_SCHEDULED_UPGRADE_NOT_SUPPORTED - - code: SOFTWARE_CONFIG_INVALID_DOWNLOAD_INTERVAL - - code: SOFTWARE_CONFIG_INVALID_UPGRADE_INTERVAL - - code: SOFTWARE_CONFIG_INVALID_DOWNLOAD_TIME - - code: SOFTWARE_CONFIG_INVALID_UPGRADE_TIME - - code: SOFTWARE_CONFIG_INCOMPATIBLE_SCHEDULES - - code: SOFTWARE_CONFIG_INVALID_INTERFACES + - code: INTERFACE_NOT_FOUND - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Upgrade an Element (v2.0) + summary: Provision Element Interface (v4.0) tags: - Device Configuration - /sdwan/v2.0/api/elements/{element_id}/software/status: + /sdwan/v4.1/api/sites/{site_id}/elements/{element_id}/interfaces: get: - description: Get the image status. - operationId: get-sdwan-v2.0-api-elements-element_id-software-status + description: Get all element interfaces. + operationId: get-sdwan-v4.1-api-sites-site_id-elements-element_id-interfaces parameters: - - description: The element ID. + - description: The site ID. in: path - name: element_id + name: site_id required: true schema: - description: Element Id + description: Site Id type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ElementImageStatus' - description: Successful Operation - summary: Get Image Status (v2.0) - tags: - - Device Configuration - /sdwan/v2.0/api/elements/{element_id}/state: - get: - description: Get the element state. - operationId: get-sdwan-v2.0-api-elements-element_id-state - parameters: - description: The element ID. in: path name: element_id @@ -8727,15 +21194,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementState' + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/InterfaceV4N1' + type: array + type: object description: Successful Operation - summary: Get Element State (v2.0) + summary: Get Element Interfaces (v4.1) tags: - Device Configuration - put: - description: Update the element state. - operationId: put-sdwan-v2.0-api-elements-element_id-state + post: + description: Create an element logical interface. + operationId: post-sdwan-v4.1-api-sites-site_id-elements-element_id-interfaces 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 @@ -8747,14 +21228,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementStateScreen' - description: Update element state + $ref: '#/components/schemas/InterfaceScreenV4N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementState' + $ref: '#/components/schemas/InterfaceV4N1' description: Successful Operation '400': content: @@ -8762,39 +21242,49 @@ paths: example: value: _error: - - code: ELEMENT_NOT_FOUND - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: ELEMENT_BOUND_ERROR - - code: ELEMENT_CONFIG_INVALID_VALUES + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Element State (v2.0) + summary: Create Element Logical Interface (v4.1) 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 + /sdwan/v4.1/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an element interface. + operationId: delete-sdwan-v4.1-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - in: path - name: machine_id + - description: The site ID. + in: path + name: site_id required: true schema: - description: Machine Id + 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MachineV2N5' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineV2N5' + $ref: '#/components/schemas/InterfaceV4N1' description: Successful Operation '400': content: @@ -8802,17 +21292,16 @@ paths: example: value: _error: - - code: ELEMENT_SHELL_NOT_FOUND + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Allocate Element Shell to Machine (v2.0) + summary: Delete Element Interface (v4.1) tags: - Device Configuration - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/admin_state: - put: - description: Update admin state Northbound. - operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-admin_state + get: + description: Get element interface details. + operationId: get-sdwan-v4.1-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -8828,47 +21317,19 @@ paths: schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Element' - description: Update admin state - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Element' - description: Successful Operation - summary: Update Admin State Northbound (v2.0) - tags: - - Device Configuration - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/application_probe: - get: - description: Get the application probe configuration of an element. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-application_probe - parameters: - - description: The site ID. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The element ID. + - description: The interface ID. in: path - name: element_id + name: interface_id required: true schema: - description: Element Id + description: Interface Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ApplicationProbe' + $ref: '#/components/schemas/InterfaceV4N1' description: Successful Operation '400': content: @@ -8876,17 +21337,16 @@ paths: example: value: _error: - - code: APPLICATION_PROBE_CONFIG_UNSUPPORTED_SWVERSION - - code: APPLICATION_PROBE_CONFIG_NOT_PRESENT + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Application Probe Configuration (v2.0) + summary: Get Element Interface Details(v4.1) tags: - Device Configuration put: - description: Update the application probe configuration of an element. - operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-application_probe + description: Provision an element interface. + operationId: put-sdwan-v4.1-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -8902,17 +21362,24 @@ paths: schema: description: Element Id type: string + - description: The interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApplicationProbeScreen' + $ref: '#/components/schemas/InterfaceScreenV4N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ApplicationProbe' + $ref: '#/components/schemas/InterfaceV4N1' description: Successful Operation '400': content: @@ -8920,61 +21387,51 @@ paths: example: value: _error: - - code: APPLICATION_PROBE_CONFIG_UNSUPPORTED_SWVERSION - - code: APPLICATION_PROBE_CONFIG_UNSUPPORTED_ROLE + - code: INTERFACE_NOT_FOUND - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: APPLICATION_PROBE_CONFIG_INVALID_SOURCE_INTERFACE + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Application Probe Configuration (v2.0) + summary: Provision Element Interface (v4.1) tags: - Device Configuration - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/extensions: - get: - description: List all the element level extensions. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-extensions - 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 + /sdwan/v4.10/api/interfaces/query: + post: + description: Query the DB for limit number of interfaces that match query params. + operationId: post-sdwan-v4.10-api-interfaces-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BaseQuery' responses: '200': content: application/json: schema: - oneOf: + allOf: - $ref: '#/components/schemas/ListQueryResponse' - - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/InterfaceQueryResponseV4N10' + 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 Element Level Extensions (v2.0) + summary: Query Interfaces (v4.10) tags: - Device Configuration - post: - description: Create an element level extension configuration. - operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-extensions + /sdwan/v4.10/api/sites/{site_id}/elements/{element_id}/interfaces: + get: + description: Get all element interfaces. + operationId: get-sdwan-v4.10-api-sites-site_id-elements-element_id-interfaces parameters: - description: The site ID. in: path @@ -8990,39 +21447,26 @@ paths: schema: description: Element Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ExtensionScreen' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/InterfaceV4N10' + type: array + type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: SITE_NOT_FOUND - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: INVALID_JSON_INPUT - - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Element Level Extension Configuration (v2.0) + summary: Get all Interfaces (v4.10) tags: - Device Configuration - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/extensions/query: post: - description: Query element level extensions that match query parameters. - operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-extensions-query + description: Create an interface. + operationId: post-sdwan-v4.10-api-sites-site_id-elements-element_id-interfaces parameters: - description: The site ID. in: path @@ -9042,20 +21486,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExtensionQuery' + $ref: '#/components/schemas/InterfaceScreenV4N10' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/ExtensionQuery' - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N10' description: Successful Operation '400': content: @@ -9063,21 +21500,44 @@ paths: example: value: _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: SITE_NOT_FOUND - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - code: INVALID_JSON_INPUT - - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_TYPE_UPDATE_NOT_ALLOWED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Element Level Extensions (v2.0) + summary: Create an Interface (v4.10) tags: - Device Configuration - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/extensions/{extension_id}: + /sdwan/v4.10/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: delete: - description: Delete a specific extension associated with an element. - operationId: delete-sdwan-v2.0-api-sites-site_id-elements-element_id-extensions-extension_id + description: Delete an interface. + operationId: delete-sdwan-v4.10-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -9093,36 +21553,26 @@ paths: schema: description: Element Id type: string - - description: The extension ID. + - description: The interface ID. in: path - name: extension_id + name: interface_id required: true schema: - description: Extension Id + description: Interface Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: '#/components/schemas/InterfaceV4N10' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: EXTENSION_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Element Level Extension (v2.0) + summary: Delete an Interface (v4.10) tags: - Device Configuration get: - description: Get a specific extension associated with an element. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-extensions-extension_id + description: Get interface details. + operationId: get-sdwan-v4.10-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -9138,36 +21588,26 @@ paths: schema: description: Element Id type: string - - description: The extension ID. + - description: The interface ID. in: path - name: extension_id + name: interface_id required: true schema: - description: Extension Id + description: Interface Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: '#/components/schemas/InterfaceV4N10' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: EXTENSION_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Element Level Extension (v2.0) + summary: Get an Interface (v4.10) tags: - Device Configuration put: - description: Update an element level extension configuration. - operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-extensions-extension_id + description: Update an interface. + operationId: put-sdwan-v4.10-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -9183,24 +21623,24 @@ paths: schema: description: Element Id type: string - - description: The extension ID. + - description: The interface ID. in: path - name: extension_id + name: interface_id required: true schema: - description: Extension Id + description: Interface Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExtensionScreen' + $ref: '#/components/schemas/InterfaceScreenV4N10' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: '#/components/schemas/InterfaceV4N10' description: Successful Operation '400': content: @@ -9208,54 +21648,68 @@ paths: example: value: _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_INPUT - - code: EXTENSION_NOT_FOUND - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Element Level Extension (v2.0) + summary: Update an Interface (v4.10) tags: - Device Configuration - /sdwan/v2.0/api/sites/{site_id}/extensions: - get: - description: List all the site level extensions. - operationId: get-sdwan-v2.0-api-sites-site_id-extensions - parameters: - - description: The site ID. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string + /sdwan/v4.11/api/interfaces/query: + post: + description: Query the DB for limit number of interfaces that match query params. + operationId: post-sdwan-v4.11-api-interfaces-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BaseQuery' responses: '200': content: application/json: schema: - oneOf: - - $ref: '#/components/schemas/ListQueryResponse' + allOf: - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BaseQuery' + type: array + type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Site Level Extensions (v2.0) + summary: Query Interfaces (v4.11) tags: - Device Configuration - post: - description: Create site level extension configuration. - operationId: post-sdwan-v2.0-api-sites-site_id-extensions + /sdwan/v4.11/api/sites/{site_id}/elements/{element_id}/interfaces: + get: + description: Get all element interfaces. + operationId: get-sdwan-v4.11-api-sites-site_id-elements-element_id-interfaces parameters: - description: The site ID. in: path @@ -9264,39 +21718,33 @@ paths: schema: description: Site Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ExtensionScreen' + - 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/Extension' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/InterfaceV4N11' + type: array + type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: SITE_NOT_FOUND - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: INVALID_JSON_INPUT - - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Site Level Extension Configuration (v2.0) + summary: Get all Interfaces (v4.11) tags: - Device Configuration - /sdwan/v2.0/api/sites/{site_id}/extensions/query: post: - description: Query site level extensions that match query parameters. - operationId: post-sdwan-v2.0-api-sites-site_id-extensions-query + description: Create an interface. + operationId: post-sdwan-v4.11-api-sites-site_id-elements-element_id-interfaces parameters: - description: The site ID. in: path @@ -9305,32 +21753,77 @@ 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/ExtensionQuery' + $ref: '#/components/schemas/InterfaceScreenV4N11' responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/ExtensionQuery' + $ref: '#/components/schemas/InterfaceV4N11' type: array type: object description: Successful Operation - summary: Query Site Level Extension (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_TYPE_UPDATE_NOT_ALLOWED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_CREATE_NOT_SUPPORTED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create an Interface (v4.11) tags: - Device Configuration - /sdwan/v2.0/api/sites/{site_id}/extensions/{extension_id}: + /sdwan/v4.11/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: delete: - description: Delete a specific extension associated with a site. - operationId: delete-sdwan-v2.0-api-sites-site_id-extensions-extension_id + description: Delete an interface. + operationId: delete-sdwan-v4.11-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -9339,36 +21832,33 @@ paths: schema: description: Site Id type: string - - description: The extension ID. + - description: The element ID. in: path - name: extension_id + name: element_id required: true schema: - description: Extension Id + 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/Extension' + $ref: '#/components/schemas/InterfaceV4N11' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: EXTENSION_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Site Level Extension (v2.0) + summary: Delete an Interface (v4.11) tags: - Device Configuration get: - description: Get a specific extension associated with a site. - operationId: get-sdwan-v2.0-api-sites-site_id-extensions-extension_id + description: Get interface details. + operationId: get-sdwan-v4.11-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -9377,36 +21867,33 @@ paths: schema: description: Site Id type: string - - description: The extension ID. + - description: The element ID. in: path - name: extension_id + name: element_id required: true schema: - description: Extension Id + 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/Extension' + $ref: '#/components/schemas/InterfaceV4N11' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: EXTENSION_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Site Level Extension (v2.0) + summary: Get an Interface (v4.11) tags: - Device Configuration put: - description: Update a specific extension configuration associated with a site. - operationId: put-sdwan-v2.0-api-sites-site_id-extensions-extension_id + description: Update an interface. + operationId: put-sdwan-v4.11-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -9415,24 +21902,31 @@ paths: schema: description: Site Id type: string - - description: The extension ID. + - description: The element ID. in: path - name: extension_id + name: element_id required: true schema: - description: Extension Id + description: Element Id + type: string + - description: The interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExtensionScreen' + $ref: '#/components/schemas/InterfaceScreenV4N11' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: '#/components/schemas/InterfaceV4N11' description: Successful Operation '400': content: @@ -9440,187 +21934,105 @@ paths: example: value: _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_INPUT - - code: EXTENSION_NOT_FOUND - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: NAT_EXTENSION_ENABLED_ON_NATPOLICY_ELEMENT - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Site Level Extension Configuration (v2.0) - tags: - - Device Configuration - /sdwan/v2.0/api/vfflicenses: - get: - description: List all the Vff licenses for a tenant. - operationId: get-sdwan-v2.0-api-vfflicenses - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/VffLicense' - type: array - type: object - description: Successful Operation - summary: Get Vff Licenses for Tenant (v2.0) - tags: - - Device Configuration - /sdwan/v2.0/api/vfflicenses/rquery: - post: - description: Query all the Vff licenses for a tenant. - operationId: post-sdwan-v2.0-api-vfflicenses-rquery - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VffLicenseQuery' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/VffLicenseQuery' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_MODEL - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Vff Licenses for Tenant (v2.0) - tags: - - Device Configuration - /sdwan/v2.0/api/vfflicenses/tokens/query: - post: - description: Query all the tenant Vff license tokens. - operationId: post-sdwan-v2.0-api-vfflicenses-tokens-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VffTokenQuery' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/VffTokenQueryFilter' - type: array - type: object - description: Successful Operation - summary: Query Vff License Tokens (v2.0) - tags: - - Device Configuration - /sdwan/v2.0/api/vfflicenses/{license_id}: - get: - description: List all the specific Vff licenses for a tenant. - operationId: get-sdwan-v2.0-api-vfflicenses-license_id - parameters: - - description: The license ID. - in: path - name: license_id - required: true - schema: - description: License Id - type: string - responses: - '200': - content: - application/json: + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED + - code: CELLULAR_INTERFACE_TYPE_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_CANNOT_BE_NULL + - code: CELLULAR_INTERFACE_PARENT_MODULE_ID_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_PARENT_SIM_SLOT_NUMBER_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_SITEWAN_NUMBER + - code: CELLULAR_INTERFACE_CONFIG_HARDWARE_RELAY_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_USED_FOR_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_INTERNET + - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_WAN + - code: CELLULAR_INTERFACE_CONFIG_MTU_INVALID + - code: CELLULAR_INTERFACE_CONFIG_DHCP_RELAY_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_LANSTATE_PROPOGATION_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILEID_INVALID_WHEN_AUTOAPN + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_APNPROFILEID_PRESENT + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_NO_USERNAME_BUT_PWD_EXISTS + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_MISSING_WHEN_AUTOAPN_FALSE_APNPROFILEID_NULL + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_INVALID_AUTH + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_MISSING_APN_NAME + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PROFILE_NAME_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILE_ID_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PASSWORD_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_USERNAME_INVALID schema: - $ref: '#/components/schemas/VffLicense' - description: Successful Operation - summary: Get Vff Licenses for Tenant (v2.0) + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update an Interface (v4.11) tags: - Device Configuration - /sdwan/v2.0/api/vfflicenses/{license_id}/operations: + /sdwan/v4.12/api/interfaces/query: post: - description: List the vff operations. - operationId: post-sdwan-v2.0-api-vfflicenses-license_id-operations - parameters: - - description: The license ID of the vff. - in: path - name: license_id - required: true - schema: - description: License Id - type: string + description: Query the DB for limit number of interfaces that match query params. + operationId: post-sdwan-v4.12-api-interfaces-query requestBody: content: application/json: schema: - $ref: '#/components/schemas/VffOperationInfo' + $ref: '#/components/schemas/BaseQuery' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VffLicenseV2' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BaseQuery' + type: array + type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_CHILD_TENANT - - code: INVALID_VFF_LICENSE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Vff Operation (v2.0) + summary: Query Interfaces (v4.12) tags: - Device Configuration - /sdwan/v2.0/api/vfflicenses/{license_id}/status: + /sdwan/v4.12/api/sites/{site_id}/elements/{element_id}/interfaces: get: - description: List the status for the Vff license. - operationId: get-sdwan-v2.0-api-vfflicenses-license_id-status + description: Get all element interfaces. + operationId: get-sdwan-v4.12-api-sites-site_id-elements-element_id-interfaces parameters: - - description: The license ID. + - description: The site ID. in: path - name: license_id + name: site_id required: true schema: - description: License Id + description: Site Id type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/VffLicenseState' - description: Successful Operation - summary: Get Status for Vff License (v2.0) - tags: - - Device Configuration - /sdwan/v2.0/api/vfflicenses/{license_id}/tokens: - get: - description: List all the tenant Vff license tokens. - operationId: get-sdwan-v2.0-api-vfflicenses-license_id-tokens - parameters: - - 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': @@ -9632,35 +22044,49 @@ paths: - properties: items: items: - $ref: '#/components/schemas/VffToken' + $ref: '#/components/schemas/InterfaceV4N12' type: array type: object description: Successful Operation - summary: Get Tenant Vff License Tokens (v2.0) + summary: Get all Interfaces (v4.12) tags: - Device Configuration post: - description: Create a tenant Vff license token. - operationId: post-sdwan-v2.0-api-vfflicenses-license_id-tokens + description: Create an interface. + operationId: post-sdwan-v4.12-api-sites-site_id-elements-element_id-interfaces parameters: - - description: The license ID. + - description: The site ID. in: path - name: license_id + name: site_id required: true schema: - description: License Id + 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/VffToken' + $ref: '#/components/schemas/InterfaceScreenV4N12' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VffToken' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/InterfaceV4N12' + type: array + type: object description: Successful Operation '400': content: @@ -9668,174 +22094,152 @@ paths: example: value: _error: + - code: INVALID_JSON_INPUT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: TOKEN_CONFIG_INVALID_POST_VALUES - - code: LICENSE_UNKNOWN - - code: ION_MAX_LIMIT - - code: ERROR_IN_TOKEN_GENERATION + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_TYPE_UPDATE_NOT_ALLOWED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_CREATE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_INVALID_MULTICAST_IGMP_VALUE + - code: INTERFACE_CONFIG_INVALID_MULTICAST_IGMP_STATIC_SRC_IPV4 + - code: INTERFACE_CONFIG_INVALID_MULTICAST_IGMP_STATIC_GRP_IPV4 + - code: INTERFACE_CONFIG_INVALID_MULTICAST_DR_PRIORITY schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Tenant Vff License Token (v2.0) + summary: Create an Interface (v4.12) tags: - Device Configuration - /sdwan/v2.0/api/vfflicenses/{license_id}/tokens/{token_id}: - get: - description: List a specific tenant Vff license token. - operationId: get-sdwan-v2.0-api-vfflicenses-license_id-tokens-token_id + /sdwan/v4.12/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an interface. + operationId: delete-sdwan-v4.12-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The license ID. + - description: The site ID. in: path - name: license_id + name: site_id required: true schema: - description: License Id + description: Site Id type: string - - description: The token ID. + - description: The element ID. in: path - name: token_id + name: element_id required: true schema: - description: Token Id + 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/VffToken' + $ref: '#/components/schemas/InterfaceV4N12' description: Successful Operation - summary: Get Tenant Vff License Token (v2.0) + summary: Delete an Interface (v4.12) tags: - Device Configuration - put: - description: Update a specific tenant Vff license token. - operationId: put-sdwan-v2.0-api-vfflicenses-license_id-tokens-token_id + get: + description: Get interface details. + operationId: get-sdwan-v4.12-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The license ID. + - description: The site ID. in: path - name: license_id + name: site_id required: true schema: - description: License Id + description: Site Id type: string - - description: The token ID. + - description: The element ID. in: path - name: token_id + name: element_id required: true schema: - description: Token Id + description: Element Id + type: string + - description: The interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VffTokenScreen' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/VffToken' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: TOKEN_CONFIG_INVALID_PUT_VALUES - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Tenant Vff License Token (v2.0) - tags: - - Device Configuration - /sdwan/v2.0/api/vfflicensesstatus/rquery: - post: - description: Query to get the license state of the virtual device (vff). - operationId: post-sdwan-v2.0-api-vfflicensesstatus-rquery - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VffLicenseStateQuery' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/VffLicenseStateQuery' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_MODEL - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query to Get Vff License State (v2.0) - tags: - - Device Configuration - /sdwan/v2.0/api/ws/extensions: - get: - description: List all the extensions from NB. - operationId: get-sdwan-v2.0-api-ws-extensions responses: '200': content: application/json: schema: - oneOf: - - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/Extension' - type: array - type: object - - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/ExtensionQueryFilter' - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N12' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: EXTENSION_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Extensions from NB (v2.0) + summary: Get an Interface (v4.12) tags: - Device Configuration - post: - description: Create an extension configuration. - operationId: post-sdwan-v2.0-api-ws-extensions + put: + description: Update an interface. + operationId: put-sdwan-v4.12-api-sites-site_id-elements-element_id-interfaces-interface_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 interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: '#/components/schemas/InterfaceScreenV4N12' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: '#/components/schemas/InterfaceV4N12' description: Successful Operation '400': content: @@ -9843,135 +22247,156 @@ paths: example: value: _error: + - code: INVALID_JSON_INPUT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: EXTENSION_NAME_REQD - - code: INVALID_EXTENSION_CONF - - code: INVALID_EXTENSION_NAMESPACE - - code: EXTENSION_NAMESPACE_REQD - - code: INVALID_EXTENSION_NAME + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED + - code: CELLULAR_INTERFACE_TYPE_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_CANNOT_BE_NULL + - code: CELLULAR_INTERFACE_PARENT_MODULE_ID_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_PARENT_SIM_SLOT_NUMBER_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_SITEWAN_NUMBER + - code: CELLULAR_INTERFACE_CONFIG_HARDWARE_RELAY_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_USED_FOR_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_INTERNET + - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_WAN + - code: CELLULAR_INTERFACE_CONFIG_MTU_INVALID + - code: CELLULAR_INTERFACE_CONFIG_DHCP_RELAY_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_LANSTATE_PROPOGATION_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILEID_INVALID_WHEN_AUTOAPN + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_APNPROFILEID_PRESENT + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_NO_USERNAME_BUT_PWD_EXISTS + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_MISSING_WHEN_AUTOAPN_FALSE_APNPROFILEID_NULL + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_INVALID_AUTH + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_MISSING_APN_NAME + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PROFILE_NAME_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILE_ID_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PASSWORD_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_USERNAME_INVALID + - code: INTERFACE_CONFIG_INVALID_MULTICAST_IGMP_VALUE + - code: INTERFACE_CONFIG_INVALID_MULTICAST_IGMP_STATIC_SRC_IPV4 + - code: INTERFACE_CONFIG_INVALID_MULTICAST_IGMP_STATIC_GRP_IPV4 + - code: INTERFACE_CONFIG_INVALID_MULTICAST_DR_PRIORITY schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Extension Configuration (v2.0) + summary: Update an Interface (v4.12) tags: - Device Configuration - /sdwan/v2.0/api/ws/extensions/query: + /sdwan/v4.13/api/interfaces/query: post: - description: Query the DB for limit number of tenant extensions that match the - query params. - operationId: post-sdwan-v2.0-api-ws-extensions-query + description: Query the DB for limit number of interfaces that match query params. + operationId: post-sdwan-v4.13-api-interfaces-query requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExtensionQuery' + $ref: '#/components/schemas/BaseQuery' responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/ExtensionQueryFilter' + $ref: '#/components/schemas/BaseQuery' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_REQUEST_ERROR_0001 - - code: INVALID_REQUEST_DUPLICATE_KEY - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query DB for Tenant Extensions (v2.0) + summary: Query Interfaces (v4.13) tags: - Device Configuration - /sdwan/v2.0/api/ws/extensions/{extension_id}: - delete: - description: Delete a specific extension configuration. - operationId: delete-sdwan-v2.0-api-ws-extensions-extension_id + /sdwan/v4.13/api/sites/{site_id}/elements/{element_id}/interfaces: + get: + description: Get all element interfaces. + operationId: get-sdwan-v4.13-api-sites-site_id-elements-element_id-interfaces parameters: - - description: The extension ID. + - description: The site ID. in: path - name: extension_id + name: site_id required: true schema: - description: Extension Id + description: Site Id type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Extension' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: EXTENSION_NAME_REQD - - code: INVALID_EXTENSION_CONF - - code: INVALID_EXTENSION_NAMESPACE - - code: EXTENSION_NAMESPACE_REQD - - code: INVALID_EXTENSION_NAME - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Extensions Configuration (v2.0) - tags: - - Device Configuration - get: - description: Get a specific extension configuration from the NB. - operationId: get-sdwan-v2.0-api-ws-extensions-extension_id - parameters: - - description: The extension ID. + - description: The element ID. in: path - name: extension_id + name: element_id required: true schema: - description: Extension Id + description: Element Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/InterfaceV4N13' + type: array + type: object description: Successful Operation - summary: Get Extensions Configuration from NB (v2.0) + summary: Get all Interfaces (v4.13) tags: - Device Configuration - put: - description: Update a specific extension configuration. - operationId: put-sdwan-v2.0-api-ws-extensions-extension_id + post: + description: Create an interface. + operationId: post-sdwan-v4.13-api-sites-site_id-elements-element_id-interfaces parameters: - - description: The extension ID. + - description: The site ID. in: path - name: extension_id + name: site_id required: true schema: - description: Extension Id + 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/Extension' + $ref: '#/components/schemas/InterfaceScreenV4N13' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: '#/components/schemas/InterfaceV4N13' description: Successful Operation '400': content: @@ -9979,71 +22404,71 @@ paths: example: value: _error: + - code: INVALID_JSON_INPUT - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: EXTENSION_NAME_REQD - - code: INVALID_EXTENSION_CONF - - code: INVALID_EXTENSION_NAMESPACE - - code: EXTENSION_NAMESPACE_REQD - - code: INVALID_EXTENSION_NAME + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_TYPE_UPDATE_NOT_ALLOWED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_CREATE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_CREATE_NOT_SUPPORTED + - 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 + - code: INTERFACE_CONFIG_VLAN_INVALID_USED_FOR_NOTSUPPORTED + - code: INTERFACE_CONFIG_VLAN_TYPE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_VLAN_INVALID_VLAN_ID + - code: INTERFACE_CONFIG_VLAN_INVALID_DUPLICATE_VLAN_ID + - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_NULL + - code: INTERFACE_CONFIG_VLAN_INVALID_MSTP_INSTANCE + - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_MAX_LENGTH + - 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 schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Extensions Configuration (v2.0) + summary: Create an Interface (v4.13) 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. - operationId: post-sdwan-v2.1-api-elements-element_id-fips_mode_change_operations + /sdwan/v4.13/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an interface. + operationId: delete-sdwan-v4.13-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The element ID. + - description: The site ID. in: path - name: element_id + name: site_id required: true schema: - description: Element Id + description: Site Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ElementOperations' - description: Details of the operations on element - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ElementOperations' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: FIPS_MODE_INVALID_OPERATION - - code: ELEMENT_NOT_FOUND - - code: ELEMENT_NOT_CONNECTED - - code: FIPS_MODE_ELEMENT_ALREADY_IN_REQUESTED_MODE - - code: FIPS_MODE_MODEL_NOT_SUPPORTED - - code: FIPS_MODE_FORBIDDEN_INVALID_STATE - - code: FIPS_MODE_CHANGE_NOT_SUPPORTED - - code: FIPS_MODE_PLEASE_RETRY_LATER - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Change Mode of Element from FIPS to Non-FIPS (v2.1) - tags: - - Device Configuration - /sdwan/v2.1/api/elements/{element_id}/software/status: - get: - description: List all the software upgrade status (up to 5) started by the tenant - user. - operationId: get-sdwan-v2.1-api-elements-element_id-software-status - parameters: - description: The element ID. in: path name: element_id @@ -10051,41 +22476,19 @@ paths: schema: description: Element Id type: string - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/BulkResponse' - - properties: - items: - items: - $ref: '#/components/schemas/ElementImageStatusV2N1' - type: array - type: object - description: Successful Operation - summary: Get Software Upgrade Status (v2.1) - tags: - - Device Configuration - /sdwan/v2.1/api/machines/{machine_id}/machinesystemstatus: - get: - description: Get the machine system status for a tenant. - operationId: get-sdwan-v2.1-api-machines-machine_id-machinesystemstatus - parameters: - - description: The machine ID. + - description: The interface ID. in: path - name: machine_id + name: interface_id required: true schema: - description: Machine Id + description: Interface Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineSystemStatusV2N1' + $ref: '#/components/schemas/InterfaceV4N13' description: Successful Operation '400': content: @@ -10093,105 +22496,87 @@ paths: example: value: _error: - - code: MACHINE_UNKNOWN - - code: MACHINE_STATUS_UNKNOWN + - code: CELLULAR_INTERFACE_CONFIG_DELETE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_DELETE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_VLAN_CONFIG_IN_USE_DELETE_UNSUPPORTED + - code: INTERFACE_CONFIG_VLAN_CONFIG_DEFAULT_VLAN_DELETE_UNSUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Machine System Status (v2.1) + summary: Delete an Interface (v4.13) tags: - Device Configuration - /sdwan/v2.1/api/machines/{machine_id}/recovery_tokens: get: - description: Get the recovery token for a machine. - operationId: get-sdwan-v2.1-api-machines-machine_id-recovery_tokens + description: Get interface details. + operationId: get-sdwan-v4.13-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The machine ID. + - description: The site ID. in: path - name: machine_id + name: site_id required: true schema: - description: Machine Id + description: Site Id type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/RecoveryToken' - description: Successful Operation - summary: Get Recovery Token for Machine (v2.1) - tags: - - Device Configuration - post: - description: Create a recovery token for the FIPs change mode. - operationId: post-sdwan-v2.1-api-machines-machine_id-recovery_tokens - parameters: - - description: The machine ID. + - description: The element ID. in: path - name: machine_id + name: element_id required: true schema: - description: Machine Id + description: Element Id + type: string + - description: The interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RecoveryTokenScreen' - description: Details of the recovery token for the element responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RecoveryToken' + $ref: '#/components/schemas/InterfaceV4N13' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: MACHINE_NOT_FOUND - - code: FIPS_MODE_ERROR_IN_TOKEN_GENERATION - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Recovery Token for FIPs (v2.1) + summary: Get an Interface (v4.13) tags: - Device Configuration - /sdwan/v2.1/api/machines/{machine_id}/recovery_tokens/{token_id}: put: - description: Update Recovery Token for Fips change mode - operationId: put-sdwan-v2.1-api-machines-machine_id-recovery_tokens-token_id + description: Update an interface. + operationId: put-sdwan-v4.13-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: Machine Id + - description: The site ID. in: path - name: machine_id + name: site_id required: true schema: - description: Machine Id + description: Site Id type: string - - description: Token Id + - description: The element ID. in: path - name: token_id + name: element_id required: true schema: - description: Token Id + description: Element Id + type: string + - description: The interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/RecoveryTokenScreen' - description: Details of the recovery token for the element + $ref: '#/components/schemas/InterfaceScreenV4N13' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RecoveryToken' + $ref: '#/components/schemas/InterfaceV4N13' description: Successful Operation '400': content: @@ -10199,82 +22584,147 @@ paths: example: value: _error: - - code: MACHINE_NOT_FOUND - - code: TOKEN_NOT_FOUND + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED + - code: CELLULAR_INTERFACE_TYPE_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_CANNOT_BE_NULL + - code: CELLULAR_INTERFACE_PARENT_MODULE_ID_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_PARENT_SIM_SLOT_NUMBER_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_SITEWAN_NUMBER + - code: CELLULAR_INTERFACE_CONFIG_HARDWARE_RELAY_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_USED_FOR_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_INTERNET + - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_WAN + - code: CELLULAR_INTERFACE_CONFIG_MTU_INVALID + - code: CELLULAR_INTERFACE_CONFIG_DHCP_RELAY_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_LANSTATE_PROPOGATION_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILEID_INVALID_WHEN_AUTOAPN + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_APNPROFILEID_PRESENT + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_NO_USERNAME_BUT_PWD_EXISTS + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_MISSING_WHEN_AUTOAPN_FALSE_APNPROFILEID_NULL + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_INVALID_AUTH + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_MISSING_APN_NAME + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PROFILE_NAME_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILE_ID_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PASSWORD_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_USERNAME_INVALID + - 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 + - code: INTERFACE_CONFIG_VLAN_INVALID_USED_FOR_NOTSUPPORTED + - code: INTERFACE_CONFIG_VLAN_TYPE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_VLAN_INVALID_VLAN_ID + - code: INTERFACE_CONFIG_VLAN_INVALID_DUPLICATE_VLAN_ID + - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_NULL + - code: INTERFACE_CONFIG_SWITCH_PORT_API_UNSUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_NOT_SUPPORTED_ON_ELEMENT + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_USED_FOR_NOTSUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_NETWORK_CONTEXT_NOTSUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_SCOPE_NOTSUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_ACCESS_MISSING_VLANID_ACCESS_OR_VOICE + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_ACCESS_TRUNK_OR_NATIVE_VLANID_NOT_APPLICABLE + - code: INTERFACE_CONFIG_SWITCH_PORT_ACCESS_VLANID_NOT_FOUND + - code: INTERFACE_CONFIG_SWITCH_PORT_VOICE_VLANID_NOT_FOUND + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_MISSING_VLAN_ID_TRUNK_OR_NATIVE + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_ACCESS_OR_VOICE_VLANID_NOT_APPLICABLE + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_NATIVE_VLANID_NOT_FOUND + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_TRUNK_VLANID_NOT_FOUND + - code: INTERFACE_CONFIG_SWITCH_PORT_TRUNK_VLANID_INVALID + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_MAC_AUTH_TYPE + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_MISSING_WHEN_VLANID_PRESENT + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_REAUTH_TIMEOUT + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_STP_PRIORITY + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_STP_COST + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_IPCONFIG_NOTSUPPORTED + - code: SWITCH_PORT_INTERFACE_CONFIG_CANNOT_BE_NULL + - code: SVI_INTERFACE_TYPE_UPDATE_NOT_ALLOWED + - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_UPDATED + - code: INTERFACE_CONFIG_VLAN_INVALID_MSTP_INSTANCE + - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_MAX_LENGTH + - 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 schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Recovery Token for Fips change mode (v2.1) - tags: - - Device Configuration - /sdwan/v2.1/api/software/current_status/query: - post: - description: Get the current image status of all the elements. - operationId: post-sdwan-v2.1-api-software-current_status-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ElementImageStatusQuery' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/ElementImageStatusQueryFilterV2N1' - type: array - type: object - description: Successful Operation - summary: Get Image Status of Element (v2.1) + summary: Update an Interface (v4.13) tags: - Device Configuration - /sdwan/v2.1/api/software/status/query: + /sdwan/v4.14/api/interfaces/query: post: - description: Query the software upgrade status of all the tenant elements. - operationId: post-sdwan-v2.1-api-software-status-query + description: Query the DB for limit number of interfaces that match query params. + operationId: post-sdwan-v4.14-api-interfaces-query requestBody: content: application/json: schema: - $ref: '#/components/schemas/ElementImageStatusQuery' + $ref: '#/components/schemas/BaseQuery' responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/ElementImageStatusQueryFilterV2N1' + $ref: '#/components/schemas/BaseQuery' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INTERFACE_NOT_FOUND - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Software Upgrade Status (v2.1) + summary: Query Interfaces (v4.14) tags: - Device Configuration - /sdwan/v2.1/api/vfflicenses: + /sdwan/v4.14/api/sites/{site_id}/elements/{element_id}/interfaces: get: - description: List all the Vff licenses for a tenant. - operationId: get-sdwan-v2.1-api-vfflicenses + description: Get all cellular interfaces. + operationId: get-sdwan-v4.14-api-sites-site_id-elements-element_id-interfaces + 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: @@ -10285,79 +22735,134 @@ paths: - properties: items: items: - $ref: '#/components/schemas/VffLicenseV2' + $ref: '#/components/schemas/InterfaceV4N14' type: array type: object description: Successful Operation - summary: Get Vff Licenses for Tenant (v2.1) + summary: Get all Cellular Interfaces (v4.14) tags: - Device Configuration - /sdwan/v2.1/api/vfflicenses/{license_id}: - get: - description: List all the specific Vff licenses for a tenant. - operationId: get-sdwan-v2.1-api-vfflicenses-license_id + post: + description: Create an interface. + operationId: post-sdwan-v4.14-api-sites-site_id-elements-element_id-interfaces parameters: - - description: The license ID. + - description: The site ID. in: path - name: license_id + name: site_id required: true schema: - description: License Id + 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/InterfaceScreenV4N14' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VffLicenseV2' + $ref: '#/components/schemas/InterfaceV4N14' description: Successful Operation - summary: Get Vff Licenses for Tenant (v2.1) + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_TYPE_UPDATE_NOT_ALLOWED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_CREATE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_CREATE_NOT_SUPPORTED + - 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 + - code: INTERFACE_CONFIG_VLAN_INVALID_USED_FOR_NOTSUPPORTED + - code: INTERFACE_CONFIG_VLAN_TYPE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_VLAN_INVALID_VLAN_ID + - code: INTERFACE_CONFIG_VLAN_INVALID_DUPLICATE_VLAN_ID + - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_NULL + - code: INTERFACE_CONFIG_VLAN_INVALID_MSTP_INSTANCE + - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_MAX_LENGTH + - 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 + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create an Interface (v4.14) tags: - Device Configuration - /sdwan/v2.1/api/vfflicenses/{license_id}/status: - get: - description: List the status for the Vff license. - operationId: get-sdwan-v2.1-api-vfflicenses-license_id-status + /sdwan/v4.14/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 parameters: - - description: The license ID. + - description: The site ID. in: path - name: license_id + name: site_id required: true schema: - description: License Id + 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/VffLicenseStateV2' - description: Successful Operation - summary: Get Status for Vff License (v2.1) - tags: - - Device Configuration - /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 + $ref: '#/components/schemas/InterfaceV4N14' description: Successful Operation '400': content: @@ -10365,31 +22870,87 @@ paths: example: value: _error: - - code: ELEMENT_STATUS_NOT_FOUND + - code: CELLULAR_INTERFACE_CONFIG_DELETE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_DELETE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_VLAN_CONFIG_IN_USE_DELETE_UNSUPPORTED + - code: INTERFACE_CONFIG_VLAN_CONFIG_DEFAULT_VLAN_DELETE_UNSUPPORTED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Element Status Objects for Tenant (v2.2) + summary: Delete Cellular Interface (v4.14) 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 + description: Get a cellular interface. + operationId: get-sdwan-v4.14-api-sites-site_id-elements-element_id-interfaces-interface_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 interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceV4N14' + description: Successful Operation + summary: Get Cellular Interface (v4.14) + tags: + - Device Configuration + put: + description: Update a cellular interface. + operationId: put-sdwan-v4.14-api-sites-site_id-elements-element_id-interfaces-interface_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 + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The interface ID. + in: path + name: interface_id required: true schema: - description: Element Id + description: Interface Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceScreenV4N14' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementStatusV2N2' + $ref: '#/components/schemas/InterfaceV4N14' description: Successful Operation '400': content: @@ -10397,24 +22958,120 @@ paths: example: value: _error: - - code: ELEMENT_STATUS_NOT_FOUND + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_REQUEST_DUPLICATE_KEY + - code: NAME_REQD + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE + - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT + - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL + - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED + - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST + - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT + - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE + - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED + - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED + - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED + - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID + - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB + - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 + - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED + - code: CELLULAR_INTERFACE_TYPE_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_CANNOT_BE_NULL + - code: CELLULAR_INTERFACE_PARENT_MODULE_ID_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_PARENT_SIM_SLOT_NUMBER_UPDATE_NOT_ALLOWED + - code: CELLULAR_INTERFACE_CONFIG_SITEWAN_NUMBER + - code: CELLULAR_INTERFACE_CONFIG_HARDWARE_RELAY_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_USED_FOR_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_INTERNET + - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_WAN + - code: CELLULAR_INTERFACE_CONFIG_MTU_INVALID + - code: CELLULAR_INTERFACE_CONFIG_DHCP_RELAY_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_LANSTATE_PROPOGATION_NOTSUPPORTED + - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILEID_INVALID_WHEN_AUTOAPN + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_APNPROFILEID_PRESENT + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_NO_USERNAME_BUT_PWD_EXISTS + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_MISSING_WHEN_AUTOAPN_FALSE_APNPROFILEID_NULL + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_INVALID_AUTH + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_MISSING_APN_NAME + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PROFILE_NAME_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILE_ID_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PASSWORD_INVALID + - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_USERNAME_INVALID + - 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 + - code: INTERFACE_CONFIG_VLAN_INVALID_USED_FOR_NOTSUPPORTED + - code: INTERFACE_CONFIG_VLAN_TYPE_NOT_SUPPORTED + - code: INTERFACE_CONFIG_VLAN_INVALID_VLAN_ID + - code: INTERFACE_CONFIG_VLAN_INVALID_DUPLICATE_VLAN_ID + - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_NULL + - code: INTERFACE_CONFIG_SWITCH_PORT_API_UNSUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_ELEMENT_ROLE + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_NOT_SUPPORTED_ON_ELEMENT + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_USED_FOR_NOTSUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_NETWORK_CONTEXT_NOTSUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_SCOPE_NOTSUPPORTED + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_ACCESS_MISSING_VLANID_ACCESS_OR_VOICE + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_ACCESS_TRUNK_OR_NATIVE_VLANID_NOT_APPLICABLE + - code: INTERFACE_CONFIG_SWITCH_PORT_ACCESS_VLANID_NOT_FOUND + - code: INTERFACE_CONFIG_SWITCH_PORT_VOICE_VLANID_NOT_FOUND + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_MISSING_VLAN_ID_TRUNK_OR_NATIVE + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_ACCESS_OR_VOICE_VLANID_NOT_APPLICABLE + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_NATIVE_VLANID_NOT_FOUND + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_TRUNK_VLANID_NOT_FOUND + - code: INTERFACE_CONFIG_SWITCH_PORT_TRUNK_VLANID_INVALID + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_MAC_AUTH_TYPE + - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_MISSING_WHEN_VLANID_PRESENT + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_REAUTH_TIMEOUT + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_STP_PRIORITY + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_STP_COST + - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_IPCONFIG_NOTSUPPORTED + - code: SWITCH_PORT_INTERFACE_CONFIG_CANNOT_BE_NULL + - code: SVI_INTERFACE_TYPE_UPDATE_NOT_ALLOWED + - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_UPDATED + - code: INTERFACE_CONFIG_VLAN_INVALID_MSTP_INSTANCE + - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_MAX_LENGTH + - 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 schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Element Status for Tenant (v2.2) + summary: Update Cellular Interface (v4.14) tags: - Device Configuration - /sdwan/v2.3/api/clients/{client_id}/machines: + /sdwan/v4.2/api/sites/{site_id}/elements/{element_id}/interfaces: get: - description: List all the machines of a tenant. - operationId: get-sdwan-v2.3-api-clients-client_id-machines + description: Get all element interfaces. + operationId: get-sdwan-v4.2-api-sites-site_id-elements-element_id-interfaces parameters: - - description: The client ID. + - description: The site ID. in: path - name: client_id + name: site_id required: true schema: - description: Client Id + description: Site Id + type: string + - description: The element ID. + in: path + name: element_id + required: true + schema: + description: Element Id type: string responses: '200': @@ -10422,58 +23079,46 @@ paths: application/json: schema: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - type: object + $ref: '#/components/schemas/InterfaceV4N2' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: INVALID_ESP_CLIENT - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Machines of Tenant (v2.3) + summary: Get Element Interfaces (v4.2) tags: - Device Configuration - /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.3-api-clients-client_id-machines-query + description: Create an element logical interface. + operationId: post-sdwan-v4.2-api-sites-site_id-elements-element_id-interfaces parameters: - - description: The client ID. + - description: The site ID. in: path - name: client_id + name: site_id required: true schema: - description: Client Id + 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/MachineQuery' + $ref: '#/components/schemas/InterfaceScreenV4N2' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - type: object - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N2' description: Successful Operation '400': content: @@ -10481,39 +23126,50 @@ paths: example: value: _error: - - code: INVALID_ESP_CLIENT - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Tenant's Client (v2.3) + summary: Create Element Logical Interface (v4.2) tags: - Device Configuration - /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.3-api-clients-client_id-machines-machine_id + /sdwan/v4.2/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an element interface. + operationId: delete-sdwan-v4.2-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The client ID. + - description: The site ID. in: path - name: client_id + name: site_id required: true schema: - description: Client Id + description: Site Id type: string - - description: The device ID. + - description: The element ID. in: path - name: machine_id + name: element_id required: true schema: - description: Machine Id + 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/MachineV2N3' + $ref: '#/components/schemas/InterfaceV4N2' description: Successful Operation '400': content: @@ -10521,94 +23177,44 @@ paths: example: value: _error: - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: INVALID_ESP_CLIENT - - code: MACHINE_UNKNOWN + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Machine of Tenant (v2.3) + summary: Delete Element Interface (v4.2) tags: - Device Configuration - /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.3-api-clients-client_id-machines-machine_id-reallocate + get: + description: Get element interface details. + operationId: get-sdwan-v4.2-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The client ID. + - description: The site ID. in: path - name: client_id + name: site_id required: true schema: - description: Client Id + description: Site Id type: string - - description: The device ID. + - description: The element ID. in: path - name: machine_id + name: element_id required: true schema: - description: Machine Id + description: Element Id + type: string + - description: The interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MachineInfoV2N3' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/MachineV2N3' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_ESP_CLIENT - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: MACHINE_UNKNOWN - - code: OPERATION_NOT_ALLOWED - - code: INVALID_OPERATION - - code: INVALID_STATE - description: If the machine is not in to_be_returned state or - allocated_to_esp states, use /operations API to move it to to_be_returned - (return operation) or allocated_to_esp (esp_received stock operation) - state, before attempting to reallocate the machine to another - client tenant. - - code: MACHINE_DELETE_DEFAULT_REGION - - code: INVALID_MACHINE_REGION - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Tenant Machine (v2.3) - tags: - - Device Configuration - /sdwan/v2.3/api/elements/status/query: - post: - description: Query the element status objects for a tenant. - operationId: post-sdwan-v2.3-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 + $ref: '#/components/schemas/InterfaceV4N2' description: Successful Operation '400': content: @@ -10616,18 +23222,24 @@ paths: example: value: _error: - - code: ELEMENT_STATUS_NOT_FOUND + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Element Status Objects for Tenant (v2.3) + summary: Get Element Interface Details (v4.2) tags: - Device Configuration - /sdwan/v2.3/api/elements/{element_id}/status: - get: - description: Get the specific element status for a tenant. - operationId: get-sdwan-v2.3-api-elements-element_id-status + put: + description: Provision an element interface. + operationId: put-sdwan-v4.2-api-sites-site_id-elements-element_id-interfaces-interface_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 @@ -10635,12 +23247,24 @@ paths: schema: description: Element Id type: string + - description: The interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceScreenV4N2' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementStatusV2N3' + $ref: '#/components/schemas/InterfaceV4N2' description: Successful Operation '400': content: @@ -10648,68 +23272,86 @@ paths: example: value: _error: - - code: ELEMENT_STATUS_NOT_FOUND + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Element Status for Tenant (v2.3) + summary: Provision Element Interface (v4.2) tags: - Device Configuration - /sdwan/v2.3/api/machines: + /sdwan/v4.3/api/sites/{site_id}/elements/{element_id}/interfaces: get: - description: Get all the machines of a tenant. - operationId: get-sdwan-v2.3-api-machines + description: Get all element interfaces. + operationId: get-sdwan-v4.3-api-sites-site_id-elements-element_id-interfaces + 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: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - $ref: '#/components/schemas/MachineV2N3' + $ref: '#/components/schemas/InterfaceV4N3' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - '404': - description: Machines not found - summary: Get Machines of Tenant (v2.3) + summary: Get Element Interfaces (v4.3) tags: - Device Configuration - /sdwan/v2.3/api/machines/query: post: - description: Query the machines of a tenant. - operationId: post-sdwan-v2.3-api-machines-query + description: Create an element logical interface. + operationId: post-sdwan-v4.3-api-sites-site_id-elements-element_id-interfaces + 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/MachineQuery' + $ref: '#/components/schemas/InterfaceScreenV4N3' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/MachineQueryFilterV2N3' - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N3' description: Successful Operation '400': content: @@ -10717,31 +23359,50 @@ paths: example: value: _error: - - code: BAD_REQUEST + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' - description: Bad request - summary: Query Machine of Tenant (v2.3) + description: Bad Request + summary: Create Element Logical Interface (v4.3) tags: - Device Configuration - /sdwan/v2.3/api/machines/{machine_id}: - get: - description: Get a specific machine of a tenant. - operationId: get-sdwan-v2.3-api-machines-machine_id + /sdwan/v4.3/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an element interface. + operationId: delete-sdwan-v4.3-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The machine ID. + - description: The site ID. in: path - name: machine_id + name: site_id required: true schema: - description: Machine Id + 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/MachineV2N3' + $ref: '#/components/schemas/InterfaceV4N3' description: Successful Operation '400': content: @@ -10749,37 +23410,84 @@ paths: example: value: _error: - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: MACHINE_UNKNOWN + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Tenant Machine (v2.3) + summary: Delete Element Interface (v4.3) tags: - Device Configuration - /sdwan/v2.3/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 + get: + description: Get element interface details. + operationId: get-sdwan-v4.3-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The machine ID. + - description: The site ID. in: path - name: machine_id + name: site_id required: true schema: - description: Machine Id + 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/InterfaceV4N3' + description: Successful Operation + summary: Get Element Interface Details (v4.3) + tags: + - Device Configuration + put: + description: Provision an element interface. + operationId: put-sdwan-v4.3-api-sites-site_id-elements-element_id-interfaces-interface_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 interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/MachineInfoV2N3' + $ref: '#/components/schemas/InterfaceScreenV4N3' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineV2N3' + $ref: '#/components/schemas/InterfaceV4N3' description: Successful Operation '400': content: @@ -10787,53 +23495,86 @@ paths: example: value: _error: - - code: ESP_OPERATION_NOT_ALLOWED - - code: INVALID_OPERATION - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: SELF_ESP_RECEIVE_STOCK_ERROR - - code: INVALID_ESP_CLIENT - - code: MACHINE_UNKNOWN - - code: INVALID_STATE - - code: LICENSE_NOT_FOUND - - code: MACHINE_INACTIVE - - code: MACHINE_DISCONNECTED - - code: PLEASE_RETRY_LATER - - code: CLAIM_ALREADY_IN_PROGRESS - - code: OPERATION_NOT_ALLOWED - - code: INVALID_ESP_MACHINE_STATE - - code: INVALID_ESP_FOR_MACHINE - - code: OPERATION_NOT_ALLOWED_FOR_VFF + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Machine (v2.3) + summary: Provision Element Interface (v4.3) tags: - Device Configuration - /sdwan/v2.5/api/clients/{client_id}/machines: + /sdwan/v4.4/api/sites/{site_id}/elements/{element_id}/interfaces: get: - description: Get all the machines allocated by ESP to a client tenant. - operationId: get-sdwan-v2.5-api-clients-client_id-machines + description: Get all element interfaces. + operationId: get-sdwan-v4.4-api-sites-site_id-elements-element_id-interfaces parameters: - - description: Tenant ID of the client tenant of the ESP. + - description: The site ID. in: path - name: client_id + name: site_id required: true schema: - description: Client Id + 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: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/InterfaceV4N4' + type: array + type: object + description: Successful Operation + summary: Get Element Interfaces (v4.4) + tags: + - Device Configuration + post: + description: Create an element logical interface. + operationId: post-sdwan-v4.4-api-sites-site_id-elements-element_id-interfaces + 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/InterfaceScreenV4N4' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - type: object - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N4' description: Successful Operation '400': content: @@ -10841,44 +23582,52 @@ paths: example: value: _error: - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: INVALID_ESP_CLIENT + - code: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INTERFACE_CONFIG_INTERFACE_TYPE_NOT_SUPPORTED + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Machines Allocated by ESP to Client Tenant (v2.5) + summary: Create Element Logical Interface (v4.4) tags: - Device Configuration - /sdwan/v2.5/api/clients/{client_id}/machines/query: - post: - description: Query and get all machines allocated by ESP to a client tenant. - operationId: post-sdwan-v2.5-api-clients-client_id-machines-query + /sdwan/v4.4/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an element interface. + operationId: delete-sdwan-v4.4-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: Tenant ID of the client tenant of the ESP. + - description: The site ID. in: path - name: client_id + name: site_id required: true schema: - description: Client Id + 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MachineQuery' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - type: object - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N4' description: Successful Operation '400': content: @@ -10886,86 +23635,84 @@ paths: example: value: _error: - - code: INVALID_ESP_CLIENT - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Machines Allocated by ESP to Client Tenant (v2.5) + summary: Delete Element Interface (v4.4) tags: - Device Configuration - /sdwan/v2.5/api/clients/{client_id}/machines/{machine_id}: get: - description: Get a specific machine allocated by ESP to a client tenant. - operationId: get-sdwan-v2.5-api-clients-client_id-machines-machine_id + description: Get element interface details. + operationId: get-sdwan-v4.4-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The client ID. + - description: The site ID. in: path - name: client_id + name: site_id required: true schema: - description: Client Id + description: Site Id type: string - - description: The device ID. + - description: The element ID. in: path - name: machine_id + name: element_id required: true schema: - description: Machine Id + 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/MachineV2N5' + $ref: '#/components/schemas/InterfaceV4N4' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: INVALID_ESP_CLIENT - - code: MACHINE_UNKNOWN - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Machine Allocated by ESP to Client Tenant (v2.5) + summary: Get Element Interface Details (v4.4) tags: - Device Configuration - /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 ESP. - operationId: post-sdwan-v2.5-api-clients-client_id-machines-machine_id-reallocate + put: + description: Provision an element interface. + operationId: put-sdwan-v4.4-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: Tenant ID (source) of the client tenant of ESP. + - description: The site ID. in: path - name: client_id + name: site_id required: true schema: - description: Client Id + description: Site Id type: string - - description: The device ID. + - description: The element ID. in: path - name: machine_id + name: element_id required: true schema: - description: Machine Id + description: Element Id + type: string + - description: The interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/MachineInfoV2N3' + $ref: '#/components/schemas/InterfaceScreenV4N4' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineV2N5' + $ref: '#/components/schemas/InterfaceV4N4' description: Successful Operation '400': content: @@ -10973,82 +23720,86 @@ paths: example: value: _error: - - code: INVALID_ESP_CLIENT - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: MACHINE_UNKNOWN - - code: OPERATION_NOT_ALLOWED - - code: INVALID_OPERATION - - code: INVALID_STATE - description: If the machine is not in to_be_returned state or - allocated_to_esp states, use /operations API to move it to to_be_returned - (return operation) or allocated_to_esp (esp_received stock operation) - state, before attempting to reallocate the machine to another - client tenant. - - code: MACHINE_DELETE_DEFAULT_REGION - - code: INVALID_MACHINE_REGION + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Reallocate Machine Client Tenant of ESP (v2.5) + summary: Provision Element Interface (v4.4) tags: - Device Configuration - /sdwan/v2.5/api/machines: + /sdwan/v4.5/api/sites/{site_id}/elements/{element_id}/interfaces: get: - description: Get all the machines of a tenant. - operationId: get-sdwan-v2.5-api-machines + description: Get all element interfaces. + operationId: get-sdwan-v4.5-api-sites-site_id-elements-element_id-interfaces + 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/MachineQuery' allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - $ref: '#/components/schemas/MachineV2N5' + $ref: '#/components/schemas/InterfaceV4N5' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - 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.5) + summary: Get Element Interfaces (v4.5) tags: - Device Configuration - /sdwan/v2.5/api/machines/query: post: - description: Query the machines of a tenant. - operationId: post-sdwan-v2.5-api-machines-query + description: Create an element logical interface. + operationId: post-sdwan-v4.5-api-sites-site_id-elements-element_id-interfaces + 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/MachineQuery' + $ref: '#/components/schemas/InterfaceScreenV4N5' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/MachineQueryFilterV2N5' - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N5' description: Successful Operation '400': content: @@ -11056,31 +23807,52 @@ paths: example: value: _error: - - code: BAD_REQUEST + - code: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INTERFACE_CONFIG_INTERFACE_TYPE_NOT_SUPPORTED + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' - description: Bad request - summary: Query Machine of Tenant (v2.5) + description: Bad Request + summary: Create Element Logical Interface (v4.5) tags: - Device Configuration - /sdwan/v2.5/api/machines/{machine_id}: - get: - description: Get a specific machine of a tenant. - operationId: get-sdwan-v2.5-api-machines-machine_id + /sdwan/v4.5/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an element interface. + operationId: delete-sdwan-v4.5-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The machine ID. + - description: The site ID. in: path - name: machine_id + name: site_id required: true schema: - description: Machine Id + 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/Machine' + $ref: '#/components/schemas/InterfaceV4N5' description: Successful Operation '400': content: @@ -11088,42 +23860,84 @@ paths: example: value: _error: - - 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 + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Tenant Machine (v2.5) + summary: Delete Element Interface (v4.5) tags: - Device Configuration - /sdwan/v2.5/api/machines/{machine_id}/operations: - post: - description: Update a specific machine of a tenant using operations. - operationId: post-sdwan-v2.5-api-machines-machine_id-operations + get: + description: Get element interface details. + operationId: get-sdwan-v4.5-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - - description: The machine ID. + - 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/InterfaceV4N5' + description: Successful Operation + summary: Get Element Interface Details (v4.5) + tags: + - Device Configuration + put: + description: Provision an element interface. + operationId: put-sdwan-v4.5-api-sites-site_id-elements-element_id-interfaces-interface_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: machine_id + name: element_id required: true schema: - description: Machine Id + description: Element Id + type: string + - description: The interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/MachineInfoV2N3' + $ref: '#/components/schemas/InterfaceScreenV4N5' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MachineV2N5' + $ref: '#/components/schemas/InterfaceV4N5' description: Successful Operation '400': content: @@ -11131,72 +23945,86 @@ paths: example: value: _error: - - code: ESP_OPERATION_NOT_ALLOWED - - code: INVALID_OPERATION - - code: TENANT_REGION_ASSOCIATION_NOT_FOUND - - code: SELF_ESP_RECEIVE_STOCK_ERROR - - code: INVALID_ESP_CLIENT - - code: MACHINE_UNKNOWN - - code: INVALID_STATE - - code: LICENSE_NOT_FOUND - - code: MACHINE_INACTIVE - - code: MACHINE_DISCONNECTED - - code: PLEASE_RETRY_LATER - - code: CLAIM_ALREADY_IN_PROGRESS - - code: OPERATION_NOT_ALLOWED - - code: INVALID_ESP_MACHINE_STATE - - code: INVALID_ESP_FOR_MACHINE - - code: OPERATION_NOT_ALLOWED_FOR_VFF + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Machine using Operations (v2.5) + summary: Provision Element Interface (v4.5) tags: - Device Configuration - /sdwan/v3.0/api/elements: + /sdwan/v4.6/api/sites/{site_id}/elements/{element_id}/interfaces: get: - description: Get the element of a tenant. - operationId: get-sdwan-v3.0-api-elements + description: Get all element interfaces. + operationId: get-sdwan-v4.6-api-sites-site_id-elements-element_id-interfaces + 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: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - $ref: '#/components/schemas/ElementV3' + $ref: '#/components/schemas/InterfaceV4N6' type: array type: object description: Successful Operation - summary: Get Element of Tenant (v3.0) + summary: Get Element Interfaces (v4.6) tags: - Device Configuration - /sdwan/v3.0/api/elements/query: post: - description: Query the DB for elements that match the query parameters. - operationId: post-sdwan-v3.0-api-elements-query + description: Create an element logical interface. + operationId: post-sdwan-v4.6-api-sites-site_id-elements-element_id-interfaces + 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/ElementQuery' - description: Queries to the element + $ref: '#/components/schemas/InterfaceScreenV4N6' responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/ElementQueryFilterV3' - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N6' description: Successful Operation '400': content: @@ -11204,18 +24032,32 @@ paths: example: value: _error: - - code: BAD_REQUEST + - code: ELEMENT_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INTERFACE_CONFIG_INTERFACE_TYPE_NOT_SUPPORTED + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Elements (v3.0) + summary: Create Element Logical Interface (v4.6) tags: - Device Configuration - /sdwan/v3.0/api/elements/{element_id}: - get: - description: Get the element of a tenant. - operationId: get-sdwan-v3.0-api-elements-element_id + /sdwan/v4.6/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an element interface. + operationId: delete-sdwan-v4.6-api-sites-site_id-elements-element_id-interfaces-interface_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 @@ -11223,26 +24065,79 @@ paths: 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/ElementV3' + $ref: '#/components/schemas/InterfaceV4N6' description: Successful Operation - '404': + '400': content: application/json: + example: + value: + _error: + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' - description: Element not found - summary: Get Element of Tenant (v3.0) + description: Bad Request + summary: Delete Element Interface (v4.6) + tags: + - Device Configuration + get: + description: Get element interface details. + operationId: get-sdwan-v4.6-api-sites-site_id-elements-element_id-interfaces-interface_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 interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceV4N6' + description: Successful Operation + summary: Get Element Interface Details (v4.6) tags: - Device Configuration put: - description: Update element for associations. - operationId: put-sdwan-v3.0-api-elements-element_id + description: Provision an element interface. + operationId: put-sdwan-v4.6-api-sites-site_id-elements-element_id-interfaces-interface_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 @@ -11250,18 +24145,24 @@ paths: schema: description: Element Id type: string + - description: The interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ElementScreenV3' - description: Update to the element + $ref: '#/components/schemas/InterfaceScreenV4N6' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementScreenV3' + $ref: '#/components/schemas/InterfaceV4N6' description: Successful Operation '400': content: @@ -11269,100 +24170,31 @@ paths: example: value: _error: - - 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: INTERFACE_NOT_FOUND - 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 + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Element for Associations (v3.0) - tags: - - Device Configuration - /sdwan/v3.1/api/elements: - get: - description: Get the element of a tenant. - operationId: get-sdwan-v3.1-api-elements - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/ElementV3N1' - type: array - type: object - description: Successful Operation - summary: Get Element of Tenant (v3.1) + summary: Provision Element Interface (v4.6) tags: - Device Configuration - /sdwan/v3.1/api/elements/query: + /sdwan/v4.7/api/interfaces/query: post: - description: Query the DB for elements that match the query parameters. - operationId: post-sdwan-v3.1-api-elements-query + description: Query the DB for limit number of element interfaces that match + query params. + operationId: post-sdwan-v4.7-api-interfaces-query requestBody: content: application/json: schema: - $ref: '#/components/schemas/ElementQuery' - description: Queries to the element + $ref: '#/components/schemas/BaseQuery' responses: '200': content: @@ -11373,7 +24205,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/ElementQueryFilterV3N1' + $ref: '#/components/schemas/InterfaceQueryResponseV4N7' type: array type: object description: Successful Operation @@ -11383,18 +24215,29 @@ paths: example: value: _error: - - code: BAD_REQUEST + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Elements (v3.1) + summary: Query Element Interfaces (v4.7) tags: - Device Configuration - /sdwan/v3.1/api/elements/{element_id}: + /sdwan/v4.7/api/sites/{site_id}/elements/{element_id}/interfaces: get: - description: Get the element of a tenant. - operationId: get-sdwan-v3.1-api-elements-element_id + description: Get all element interfaces. + operationId: get-sdwan-v4.7-api-sites-site_id-elements-element_id-interfaces 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 @@ -11407,21 +24250,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementV3N1' + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/InterfaceV4N7' + type: array + type: object description: Successful Operation - '404': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Element not found - summary: Get Element of Tenant (v3.1) + summary: Get Element Interfaces (v4.7) tags: - Device Configuration - put: - description: Update element for associations. - operationId: put-sdwan-v3.1-api-elements-element_id + post: + description: Create an element logical interface. + operationId: post-sdwan-v4.7-api-sites-site_id-elements-element_id-interfaces 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 @@ -11433,14 +24284,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ElementScreenV3N1' - description: Update to the element + $ref: '#/components/schemas/InterfaceScreenV4N7' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementScreenV3N1' + $ref: '#/components/schemas/InterfaceV4N7' description: Successful Operation '400': content: @@ -11448,126 +24298,69 @@ paths: example: value: _error: - - 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: 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: INTERFACE_CONFIG_INTERFACE_TYPE_NOT_SUPPORTED + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Element for Associations (v3.1) + summary: Create Element Logical Interface (v4.7) tags: - Device Configuration - /sdwan/v3.1/api/machines/rquery: - post: - description: Query and get all MSP machines across regions. - operationId: post-sdwan-v3.1-api-machines-rquery - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MachineQuery' - description: Details of machine query + /sdwan/v4.7/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + delete: + description: Delete an element interface. + operationId: delete-sdwan-v4.7-api-sites-site_id-elements-element_id-interfaces-interface_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 interface ID. + in: path + name: interface_id + required: true + schema: + description: Interface Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/MachineQuery' - type: array - type: object + $ref: '#/components/schemas/InterfaceV4N7' description: Successful Operation - summary: Query MSP Machines across Regions (v3.1) - tags: - - Device Configuration - /sdwan/v3.2/api/machines/rquery: - post: - description: Query and get all MSP machines across regions. - operationId: post-sdwan-v3.2-api-machines-rquery - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MachineQuery' - description: Details of machine query - responses: - '200': + '400': content: application/json: + example: + value: + _error: + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/MachineQuery' - type: array - type: object - description: Successful Operation - summary: Query MSP Machines across Regions (v3.2) + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Element Interface (v4.7) tags: - Device Configuration - /sdwan/v3.5/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 + description: Get element interface details. + operationId: get-sdwan-v4.7-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -11595,15 +24388,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceStateV3N5' + $ref: '#/components/schemas/InterfaceV4N7' description: Successful Operation - summary: Get Interface Status (v3.5) + summary: Get Element Interface Details (v4.7) tags: - Device Configuration - /sdwan/v3.6/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}/status: - get: - description: Get interface status. - operationId: get-sdwan-v3.6-api-sites-site_id-elements-element_id-interfaces-interface_id-status + put: + description: Provision an element interface. + operationId: put-sdwan-v4.7-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -11626,20 +24418,44 @@ paths: schema: description: Interface Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceScreenV4N7' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceStateV3N6' + $ref: '#/components/schemas/InterfaceV4N7' description: Successful Operation - summary: Get Interface Status (v3.6) + '400': + content: + application/json: + example: + value: + _error: + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET + - code: INTERFACE_CONFIG_IP_OVERLAP + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Provision Element Interface (v4.7) tags: - Device Configuration - /sdwan/v4.16/api/interfaces/query: + /sdwan/v4.8/api/interfaces/query: post: - description: Queries db for limit number of interfaces that match query params. - operationId: post-sdwan-v4.16-api-interfaces-query + description: Query the DB for limit number of element interfaces that match + query params. + operationId: post-sdwan-v4.8-api-interfaces-query requestBody: content: application/json: @@ -11651,22 +24467,35 @@ paths: application/json: schema: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/ListQueryResponse' - properties: items: items: - $ref: '#/components/schemas/BaseQuery' + $ref: '#/components/schemas/InterfaceQueryResponseV4N8' type: array type: object description: Successful Operation - summary: Queries db for limit number of interfaces that match query params. - (v4.16) + '400': + content: + application/json: + example: + value: + _error: + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Element Interfaces (v4.8) tags: - Device Configuration - /sdwan/v4.16/api/sites/{site_id}/elements/{element_id}/interfaces: + /sdwan/v4.8/api/sites/{site_id}/elements/{element_id}/interfaces: get: - description: Get all cellular interfaces. - operationId: get-sdwan-v4.16-api-sites-site_id-elements-element_id-interfaces + description: Get all element interfaces. + operationId: get-sdwan-v4.8-api-sites-site_id-elements-element_id-interfaces parameters: - description: The site ID. in: path @@ -11688,20 +24517,20 @@ paths: application/json: schema: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - $ref: '#/components/schemas/InterfaceV4N16' + $ref: '#/components/schemas/InterfaceV4N8' type: array type: object description: Successful Operation - summary: Get all Cellular Interfaces (v4.16) + summary: Get Element Interfaces (v4.8) tags: - Device Configuration post: - description: Create an interface. - operationId: post-sdwan-v4.16-api-sites-site_id-elements-element_id-interfaces + description: Create an element logical interface. + operationId: post-sdwan-v4.8-api-sites-site_id-elements-element_id-interfaces parameters: - description: The site ID. in: path @@ -11721,13 +24550,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceScreenV4N16' + $ref: '#/components/schemas/InterfaceScreenV4N8' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N16' + $ref: '#/components/schemas/InterfaceV4N8' description: Successful Operation '400': content: @@ -11735,64 +24564,24 @@ paths: example: value: _error: - - code: INVALID_JSON_INPUT + - code: ELEMENT_NOT_FOUND - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: NAME_REQD - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE - - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED - - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED - - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED - - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT - - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL - - code: INTERFACE_CONFIG_SERVICE_LINK_TYPE_UPDATE_NOT_ALLOWED - - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST - - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_INTERFACE_TYPE_NOT_SUPPORTED + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET - code: INTERFACE_CONFIG_IP_OVERLAP - - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT - - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE - - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED - - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED - - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED - - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED - - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID - - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID - - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB - - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 - - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED - - code: CELLULAR_INTERFACE_CONFIG_CREATE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_CREATE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_POE_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_VLAN_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_POE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_LLDP_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_API_UNSUPPORTED - - code: INTERFACE_CONFIG_VLAN_INVALID_NOT_SUPPORTED_ON_ELEMENT - - code: INTERFACE_CONFIG_VLAN_INVALID_USED_FOR_NOTSUPPORTED - - code: INTERFACE_CONFIG_VLAN_TYPE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_INVALID_VLAN_ID - - code: INTERFACE_CONFIG_VLAN_INVALID_DUPLICATE_VLAN_ID - - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_NULL - - code: INTERFACE_CONFIG_VLAN_INVALID_MSTP_INSTANCE - - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_MAX_LENGTH - - 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 + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create an Interface (v4.16) + summary: Create Element Logical Interface (v4.8) tags: - Device Configuration - /sdwan/v4.16/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + /sdwan/v4.8/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: delete: - description: Delete a cellular interface. - operationId: delete-sdwan-v4.16-api-sites-site_id-elements-element_id-interfaces-interface_id + description: Delete an element interface. + operationId: delete-sdwan-v4.8-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -11820,27 +24609,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N16' + $ref: '#/components/schemas/InterfaceV4N8' description: Successful Operation '400': content: application/json: example: - value: - _error: - - code: CELLULAR_INTERFACE_CONFIG_DELETE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_DELETE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_CONFIG_IN_USE_DELETE_UNSUPPORTED - - code: INTERFACE_CONFIG_VLAN_CONFIG_DEFAULT_VLAN_DELETE_UNSUPPORTED + value: + _error: + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Cellular Interface (v4.16) + summary: Delete Element Interface (v4.8) tags: - Device Configuration get: - description: Get a cellular interface. - operationId: get-sdwan-v4.16-api-sites-site_id-elements-element_id-interfaces-interface_id + description: Get element interface details. + operationId: get-sdwan-v4.8-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -11868,14 +24654,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N16' + $ref: '#/components/schemas/InterfaceV4N8' description: Successful Operation - summary: Get Cellular Interface (v4.16) + summary: Get Element Interface Details (v4.8) tags: - Device Configuration put: - description: Update a cellular interface. - operationId: put-sdwan-v4.16-api-sites-site_id-elements-element_id-interfaces-interface_id + description: Provision an element interface. + operationId: put-sdwan-v4.8-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -11902,13 +24688,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceScreenV4N16' + $ref: '#/components/schemas/InterfaceScreenV4N8' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N16' + $ref: '#/components/schemas/InterfaceV4N8' description: Successful Operation '400': content: @@ -11916,107 +24702,26 @@ paths: example: value: _error: - - code: INVALID_JSON_INPUT + - code: INTERFACE_NOT_FOUND - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: NAME_REQD - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE - - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED - - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED - - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT - - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL - - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED - - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST - - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET - code: INTERFACE_CONFIG_IP_OVERLAP - - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT - - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE - - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED - - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED - - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED - - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED - - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID - - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID - - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB - - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 - - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED - - code: CELLULAR_INTERFACE_TYPE_UPDATE_NOT_ALLOWED - - code: CELLULAR_INTERFACE_CONFIG_CANNOT_BE_NULL - - code: CELLULAR_INTERFACE_PARENT_MODULE_ID_UPDATE_NOT_ALLOWED - - code: CELLULAR_INTERFACE_PARENT_SIM_SLOT_NUMBER_UPDATE_NOT_ALLOWED - - code: CELLULAR_INTERFACE_CONFIG_SITEWAN_NUMBER - - code: CELLULAR_INTERFACE_CONFIG_HARDWARE_RELAY_NOTSUPPORTED - - code: CELLULAR_INTERFACE_CONFIG_USED_FOR_NOTSUPPORTED - - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_INTERNET - - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_WAN - - code: CELLULAR_INTERFACE_CONFIG_MTU_INVALID - - code: CELLULAR_INTERFACE_CONFIG_DHCP_RELAY_NOTSUPPORTED - - code: CELLULAR_INTERFACE_CONFIG_LANSTATE_PROPOGATION_NOTSUPPORTED - - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILEID_INVALID_WHEN_AUTOAPN - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_APNPROFILEID_PRESENT - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_NO_USERNAME_BUT_PWD_EXISTS - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_MISSING_WHEN_AUTOAPN_FALSE_APNPROFILEID_NULL - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_INVALID_AUTH - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_MISSING_APN_NAME - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PROFILE_NAME_INVALID - - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILE_ID_INVALID - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PASSWORD_INVALID - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_USERNAME_INVALID - - code: INTERFACE_CONFIG_POE_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_VLAN_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_POE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_LLDP_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_API_UNSUPPORTED - - code: INTERFACE_CONFIG_VLAN_INVALID_NOT_SUPPORTED_ON_ELEMENT - - code: INTERFACE_CONFIG_VLAN_INVALID_USED_FOR_NOTSUPPORTED - - code: INTERFACE_CONFIG_VLAN_TYPE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_INVALID_VLAN_ID - - code: INTERFACE_CONFIG_VLAN_INVALID_DUPLICATE_VLAN_ID - - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_NULL - - code: INTERFACE_CONFIG_SWITCH_PORT_API_UNSUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_NOT_SUPPORTED_ON_ELEMENT - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_USED_FOR_NOTSUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_NETWORK_CONTEXT_NOTSUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_SCOPE_NOTSUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_ACCESS_MISSING_VLANID_ACCESS_OR_VOICE - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_ACCESS_TRUNK_OR_NATIVE_VLANID_NOT_APPLICABLE - - code: INTERFACE_CONFIG_SWITCH_PORT_ACCESS_VLANID_NOT_FOUND - - code: INTERFACE_CONFIG_SWITCH_PORT_VOICE_VLANID_NOT_FOUND - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_MISSING_VLAN_ID_TRUNK_OR_NATIVE - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_ACCESS_OR_VOICE_VLANID_NOT_APPLICABLE - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_NATIVE_VLANID_NOT_FOUND - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_TRUNK_VLANID_NOT_FOUND - - code: INTERFACE_CONFIG_SWITCH_PORT_TRUNK_VLANID_INVALID - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_MAC_AUTH_TYPE - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_MISSING_WHEN_VLANID_PRESENT - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_REAUTH_TIMEOUT - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_STP_PRIORITY - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_STP_COST - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_IPCONFIG_NOTSUPPORTED - - code: SWITCH_PORT_INTERFACE_CONFIG_CANNOT_BE_NULL - - code: SVI_INTERFACE_TYPE_UPDATE_NOT_ALLOWED - - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_UPDATED - - code: INTERFACE_CONFIG_VLAN_INVALID_MSTP_INSTANCE - - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_MAX_LENGTH - - 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 + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Cellular Interface (v4.16) + summary: Provision Element Interface (v4.8) tags: - Device Configuration - /sdwan/v4.17/api/interfaces/query: + /sdwan/v4.9/api/interfaces/query: post: - description: Queries db for limit number of interfaces that match query params. - operationId: post-sdwan-v4.17-api-interfaces-query + description: Query the DB for limit number of element interfaces that match + query params. + operationId: post-sdwan-v4.9-api-interfaces-query requestBody: content: application/json: @@ -12028,22 +24733,33 @@ paths: application/json: schema: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/ListQueryResponse' - properties: items: items: - $ref: '#/components/schemas/BaseQuery' + $ref: '#/components/schemas/InterfaceQueryResponseV4N9' type: array type: object description: Successful Operation - summary: Queries db for limit number of interfaces that match query params. - (v4.17) + '400': + content: + application/json: + example: + value: + _error: + - code: INTERFACE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query Element Interfaces (v4.9) tags: - Device Configuration - /sdwan/v4.17/api/sites/{site_id}/elements/{element_id}/interfaces: + /sdwan/v4.9/api/sites/{site_id}/elements/{element_id}/interfaces: get: - description: Get all cellular interfaces. - operationId: get-sdwan-v4.17-api-sites-site_id-elements-element_id-interfaces + description: Get all element interfaces. + operationId: get-sdwan-v4.9-api-sites-site_id-elements-element_id-interfaces parameters: - description: The site ID. in: path @@ -12065,20 +24781,20 @@ paths: application/json: schema: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - $ref: '#/components/schemas/InterfaceV4N17' + $ref: '#/components/schemas/InterfaceV4N9' type: array type: object description: Successful Operation - summary: Get all Cellular Interfaces (v4.17) + summary: Get Element Interfaces (v4.9) tags: - Device Configuration post: - description: Create an interface. - operationId: post-sdwan-v4.17-api-sites-site_id-elements-element_id-interfaces + description: Create an element logical interface. + operationId: post-sdwan-v4.9-api-sites-site_id-elements-element_id-interfaces parameters: - description: The site ID. in: path @@ -12098,13 +24814,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceScreenV4N17' + $ref: '#/components/schemas/InterfaceScreenV4N9' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N17' + $ref: '#/components/schemas/InterfaceV4N9' description: Successful Operation '400': content: @@ -12112,66 +24828,24 @@ paths: example: value: _error: - - code: INVALID_JSON_INPUT + - code: ELEMENT_NOT_FOUND - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: NAME_REQD - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE - - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED - - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED - - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED - - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT - - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL - - code: INTERFACE_CONFIG_SERVICE_LINK_TYPE_UPDATE_NOT_ALLOWED - - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST - - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INTERFACE_CONFIG_INTERFACE_TYPE_NOT_SUPPORTED + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET - code: INTERFACE_CONFIG_IP_OVERLAP - - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT - - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE - - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED - - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED - - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED - - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED - - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID - - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID - - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB - - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 - - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED - - code: CELLULAR_INTERFACE_CONFIG_CREATE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_CREATE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_POE_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_VLAN_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_POE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_LLDP_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_API_UNSUPPORTED - - code: INTERFACE_CONFIG_VLAN_INVALID_NOT_SUPPORTED_ON_ELEMENT - - code: INTERFACE_CONFIG_VLAN_INVALID_USED_FOR_NOTSUPPORTED - - code: INTERFACE_CONFIG_VLAN_TYPE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_INVALID_VLAN_ID - - code: INTERFACE_CONFIG_VLAN_INVALID_DUPLICATE_VLAN_ID - - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_NULL - - code: INTERFACE_CONFIG_VLAN_INVALID_MSTP_INSTANCE - - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_MAX_LENGTH - - 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 - - code: INTERFACE_CONFIG_CONTROLLER_INTF_ALREADY_EXISTS - - code: INTERFACE_CONFIG_USED_FOR_CONTROLLER_NOT_SUPPORTED + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create an Interface (v4.17) + summary: Create Element Logical Interface (v4.9) tags: - Device Configuration - /sdwan/v4.17/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: + /sdwan/v4.9/api/sites/{site_id}/elements/{element_id}/interfaces/{interface_id}: delete: - description: Delete a cellular interface. - operationId: delete-sdwan-v4.17-api-sites-site_id-elements-element_id-interfaces-interface_id + description: Delete an element interface. + operationId: delete-sdwan-v4.9-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -12199,7 +24873,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N17' + $ref: '#/components/schemas/InterfaceV4N9' description: Successful Operation '400': content: @@ -12207,19 +24881,16 @@ paths: example: value: _error: - - code: CELLULAR_INTERFACE_CONFIG_DELETE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_DELETE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_CONFIG_IN_USE_DELETE_UNSUPPORTED - - code: INTERFACE_CONFIG_VLAN_CONFIG_DEFAULT_VLAN_DELETE_UNSUPPORTED + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Cellular Interface (v4.17) + summary: Delete Element Interface (v4.9) tags: - Device Configuration get: - description: Get a cellular interface. - operationId: get-sdwan-v4.17-api-sites-site_id-elements-element_id-interfaces-interface_id + description: Get element interface details. + operationId: get-sdwan-v4.9-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -12247,14 +24918,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N17' + $ref: '#/components/schemas/InterfaceV4N9' description: Successful Operation - summary: Get Cellular Interface (v4.17) + summary: Get Element Interface Details (v4.9) tags: - Device Configuration put: - description: Update a cellular interface. - operationId: put-sdwan-v4.17-api-sites-site_id-elements-element_id-interfaces-interface_id + description: Provision an element interface. + operationId: put-sdwan-v4.9-api-sites-site_id-elements-element_id-interfaces-interface_id parameters: - description: The site ID. in: path @@ -12281,13 +24952,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterfaceScreenV4N17' + $ref: '#/components/schemas/InterfaceScreenV4N9' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/InterfaceV4N17' + $ref: '#/components/schemas/InterfaceV4N9' description: Successful Operation '400': content: @@ -12295,103 +24966,19 @@ paths: example: value: _error: - - code: INVALID_JSON_INPUT + - code: INTERFACE_NOT_FOUND - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: NAME_REQD - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INTERFACE_CONFIG_SERVICE_LINK_UNSUPPORTED_GRE_TYPE - - code: INTERFACE_CONFIG_SERVICE_LINK_IPSEC_CONFIG_NOT_ALLOWED - - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_NOT_ALLOWED - - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_FAIL_COUNT - - code: INTERFACE_CONFIG_SERVICE_LINK_INVALID_GRE_KEEPALIVE_INTERVAL - - code: INTERFACE_CONFIG_SERVICE_LINK_GRE_CONFIG_REQUIRED - - code: INTERFACE_CONFIG_UNSUPPORTED_DIRECTED_BROADCAST - - code: INTERFACE_CONFIG_INVALID_DIRECTED_BROADCAST_CONFIG + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: ELEMENT_NOT_BOUND + - code: INVALID_HOST_IP_RANGE + - code: INTERFACE_CONFIG_GTWY_NOT_IN_SUBNET - code: INTERFACE_CONFIG_IP_OVERLAP - - code: INTERFACE_CONFIG_SECONDARY_IP_EXCEEDS_LIMIT - - code: INTERFACE_CONFIG_SECONDARY_IP_UNSUPPORTED_TYPE - - code: INTERFACE_CONFIG_PRIMARY_IP_DHCP_NOT_ALLOWED - - code: INTERFACE_CONFIG_SECONDARY_IP_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_SECONDARY_IP_NOT_SUPPORTED_LAN_FORWARDING_NOT_ENABLED - - code: INTERFACE_CONFIG_SECONDARY_IP_USED_FOR_UNSUPPORTED - - code: INTERFACE_CONFIG_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED - - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID - - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID - - code: INTERFACE_CONFIG_INVALID_CONFIG_ON_HUB - - code: INTERFACE_CONFIG_INVALID_IPFIX_COLLECTOR_CONTEXT_ID_NOT_ALLOWED_FOR_BYPASSPAIR_USED_FOR_PRIVATE_L2 - - code: INTERFACE_CONFIG_INVALID_IPFIX_FILTER_CONTEXT_ID_NOT_ALLOWED - - code: CELLULAR_INTERFACE_TYPE_UPDATE_NOT_ALLOWED - - code: CELLULAR_INTERFACE_CONFIG_CANNOT_BE_NULL - - code: CELLULAR_INTERFACE_PARENT_MODULE_ID_UPDATE_NOT_ALLOWED - - code: CELLULAR_INTERFACE_PARENT_SIM_SLOT_NUMBER_UPDATE_NOT_ALLOWED - - code: CELLULAR_INTERFACE_CONFIG_SITEWAN_NUMBER - - code: CELLULAR_INTERFACE_CONFIG_HARDWARE_RELAY_NOTSUPPORTED - - code: CELLULAR_INTERFACE_CONFIG_USED_FOR_NOTSUPPORTED - - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_INTERNET - - code: CELLULAR_INTERFACE_CONFIG_INVALID_USED_FOR_WAN - - code: CELLULAR_INTERFACE_CONFIG_MTU_INVALID - - code: CELLULAR_INTERFACE_CONFIG_DHCP_RELAY_NOTSUPPORTED - - code: CELLULAR_INTERFACE_CONFIG_LANSTATE_PROPOGATION_NOTSUPPORTED - - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILEID_INVALID_WHEN_AUTOAPN - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_APNPROFILEID_PRESENT - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_NO_USERNAME_BUT_PWD_EXISTS - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_MISSING_WHEN_AUTOAPN_FALSE_APNPROFILEID_NULL - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_AUTOAPN_FALSE_INVALID_AUTH - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_INVALID_WHEN_MISSING_APN_NAME - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PROFILE_NAME_INVALID - - code: CELLULAR_INTERFACE_CONFIG_APN_PROFILE_ID_INVALID - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_PASSWORD_INVALID - - code: CELLULAR_INTERFACE_CONFIG_APN_CONFIG_USERNAME_INVALID - - code: INTERFACE_CONFIG_POE_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_VLAN_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_POE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_LLDP_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_API_UNSUPPORTED - - code: INTERFACE_CONFIG_VLAN_INVALID_NOT_SUPPORTED_ON_ELEMENT - - code: INTERFACE_CONFIG_VLAN_INVALID_USED_FOR_NOTSUPPORTED - - code: INTERFACE_CONFIG_VLAN_TYPE_NOT_SUPPORTED - - code: INTERFACE_CONFIG_VLAN_INVALID_VLAN_ID - - code: INTERFACE_CONFIG_VLAN_INVALID_DUPLICATE_VLAN_ID - - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_NULL - - code: INTERFACE_CONFIG_SWITCH_PORT_API_UNSUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_ELEMENT_ROLE - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_NOT_SUPPORTED_ON_ELEMENT - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_USED_FOR_NOTSUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_NETWORK_CONTEXT_NOTSUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_SCOPE_NOTSUPPORTED - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_ACCESS_MISSING_VLANID_ACCESS_OR_VOICE - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_ACCESS_TRUNK_OR_NATIVE_VLANID_NOT_APPLICABLE - - code: INTERFACE_CONFIG_SWITCH_PORT_ACCESS_VLANID_NOT_FOUND - - code: INTERFACE_CONFIG_SWITCH_PORT_VOICE_VLANID_NOT_FOUND - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_MISSING_VLAN_ID_TRUNK_OR_NATIVE - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_ACCESS_OR_VOICE_VLANID_NOT_APPLICABLE - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_NATIVE_VLANID_NOT_FOUND - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_TRUNK_TRUNK_VLANID_NOT_FOUND - - code: INTERFACE_CONFIG_SWITCH_PORT_TRUNK_VLANID_INVALID - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_MAC_AUTH_TYPE - - code: INTERFACE_CONFIG_SWITCH_PORT_VLAN_MODE_MISSING_WHEN_VLANID_PRESENT - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_DOT1X_REAUTH_TIMEOUT - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_STP_PRIORITY - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_STP_COST - - code: INTERFACE_CONFIG_SWITCH_PORT_INVALID_IPCONFIG_NOTSUPPORTED - - code: SWITCH_PORT_INTERFACE_CONFIG_CANNOT_BE_NULL - - code: SVI_INTERFACE_TYPE_UPDATE_NOT_ALLOWED - - code: INTERFACE_CONFIG_VLAN_CONFIG_CANNOT_BE_UPDATED - - code: INTERFACE_CONFIG_VLAN_INVALID_MSTP_INSTANCE - - code: INTERFACE_CONFIG_VLAN_INVALID_NAME_MAX_LENGTH - - 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 - - code: INTERFACE_CONFIG_CONTROLLER_INTF_ALREADY_EXISTS - - code: INTERFACE_CONFIG_USED_FOR_CONTROLLER_NOT_SUPPORTED + - code: INTERFACE_CONFIG_PEER_IP_OVERLAP + - code: SHADIGEST_ELEMENT_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Cellular Interface (v4.17) + summary: Provision Element Interface (v4.9) tags: - Device Configuration servers: diff --git a/openapi-specs/sdwan/unified/DeviceSwitchConfiguration.yaml b/openapi-specs/sdwan/unified/DeviceSwitchConfiguration.yaml index a32cb1ec7..adb85afd7 100644 --- a/openapi-specs/sdwan/unified/DeviceSwitchConfiguration.yaml +++ b/openapi-specs/sdwan/unified/DeviceSwitchConfiguration.yaml @@ -2,21 +2,9 @@ components: schemas: Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -30,28 +18,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 ClientDetails: properties: aging_timeout: @@ -112,6 +78,15 @@ components: ' type: integer + required: + - stats_start_time_ms + - uptime + - reauth_timeout + - vlan_id + - username + - mac_address + - interface_id + - element_id ElementRadius: properties: description: diff --git a/openapi-specs/sdwan/unified/EventPolicy.yaml b/openapi-specs/sdwan/unified/EventPolicy.yaml index cce7f736c..4ddddf6c9 100644 --- a/openapi-specs/sdwan/unified/EventPolicy.yaml +++ b/openapi-specs/sdwan/unified/EventPolicy.yaml @@ -2,21 +2,9 @@ components: schemas: Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -30,28 +18,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 Error: properties: _error: @@ -160,7 +126,6 @@ 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 @@ -169,7 +134,6 @@ 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 @@ -225,20 +189,6 @@ components: - 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: @@ -281,7 +231,6 @@ components: - bgppeer - interface - waninterface - - wannetwork - networkpolicyset - prioritypolicyset - natpolicyset @@ -289,7 +238,6 @@ components: - appdef - serviceendpoint - cellular_module - - user_id type: string start_time: description: 'The start date in MM/DD/YYYY HH: mm format of the event policy @@ -371,874 +319,36 @@ components: ' 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. - - ' - enabled: - description: 'The enabled event correlation policy rules. - - ' - 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 - 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: 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: 'ID of the event policy set. - - ' - type: string - 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: - description: 'Priority level set for the event policy rule. - - ' - enum: - - p1 - - p2 - - p3 - - p4 - - p5 - - none - type: string - 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: - - site - - element - - anynetlink - - bgppeer - - interface - - waninterface - - wannetwork - - networkpolicyset - - prioritypolicyset - - natpolicyset - - securitypolicyset - - appdef - - serviceendpoint - - cellular_module - - user_id - type: string - start_time: - description: 'The start date in MM/DD/YYYY HH: mm format of the event policy - rule applied. - - ' - 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 - 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. \n" - items: - description: Tags - type: string - type: array - required: - - priority - - suppress - - name - EventCorrelationPolicyRuleQueryFilterV2N1: - properties: - dampening_duration: - description: 'Dampening duration cannot be less than 5 minutes. Dampening - for duration cannot be more than 10080 minutes(a week). - - ' - type: integer - description: - description: 'Description of the event correlation policy rules. - - ' - enabled: - description: 'The enabled event correlation policy rules. - - ' - 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 - 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: 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: 'ID of the event policy set. - - ' - type: string - 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: - description: 'Priority level set for the event policy rule. - - ' - enum: - - p1 - - p2 - - p3 - - p4 - - p5 - - none - type: string - 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: - - site - - element - - anynetlink - - bgppeer - - interface - - waninterface - - wannetwork - - networkpolicyset - - prioritypolicyset - - natpolicyset - - securitypolicyset - - appdef - - serviceendpoint - - cellular_module - - user_id - type: string - start_time: - description: 'The start date in MM/DD/YYYY HH: mm format of the event policy - rule applied. - - ' - 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 - 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 - required: - - 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: - description: 'Description of the event correlation policy rules. - - ' - enabled: - description: 'The enabled event correlation policy rules. - - ' - 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 - 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: 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: 'ID of the event policy set. - - ' - type: string - name: - description: 'Name of the event policy set. Max 25 characters. - - ' - type: string - priority: - description: 'Priority level set for the event policy rule. - - ' - enum: - - p1 - - p2 - - p3 - - p4 - - p5 - - none - type: string - 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: - - site - - element - - anynetlink - - bgppeer - - interface - - waninterface - - wannetwork - - networkpolicyset - - prioritypolicyset - - natpolicyset - - securitypolicyset - - appdef - - serviceendpoint - - cellular_module - - user_id - type: string - start_time: - description: 'The start date in MM/DD/YYYY HH: mm format of the event policy - rule applied. - - ' - 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 - 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. \n" + next_query: + description: 'The limit. + + ' + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. + + ' items: - description: Tags + description: Retrieved Fields type: string type: array - required: - - priority - - suppress - - name - EventCorrelationPolicyRuleScreenV2N1: - properties: - dampening_duration: - description: 'Dampening duration cannot be less than 5 minutes. Dampening - for duration cannot be more than 10080 minutes(a week). + 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. @@ -1314,7 +424,6 @@ 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 @@ -1323,7 +432,6 @@ 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 @@ -1379,20 +487,6 @@ components: - 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: @@ -1403,6 +497,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: @@ -1435,7 +534,6 @@ components: - bgppeer - interface - waninterface - - wannetwork - networkpolicyset - prioritypolicyset - natpolicyset @@ -1443,7 +541,6 @@ components: - appdef - serviceendpoint - cellular_module - - user_id type: string start_time: description: 'The start date in MM/DD/YYYY HH: mm format of the event policy @@ -1475,11 +572,9 @@ 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. - - ' + 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 @@ -1488,14 +583,8 @@ components: - priority - suppress - name - EventCorrelationPolicyRuleV2N1: + EventCorrelationPolicyRuleScreen: properties: - dampening_duration: - description: 'Dampening duration cannot be less than 5 minutes. Dampening - for duration cannot be more than 10080 minutes(a week). - - ' - type: integer description: description: 'Description of the event correlation policy rules. @@ -1571,7 +660,6 @@ 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 @@ -1580,7 +668,6 @@ 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 @@ -1636,20 +723,6 @@ components: - 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: @@ -1692,7 +765,6 @@ components: - bgppeer - interface - waninterface - - wannetwork - networkpolicyset - prioritypolicyset - natpolicyset @@ -1700,7 +772,6 @@ components: - appdef - serviceendpoint - cellular_module - - user_id type: string start_time: description: 'The start date in MM/DD/YYYY HH: mm format of the event policy @@ -1732,11 +803,9 @@ 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. - - ' + 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 @@ -2352,7 +1421,7 @@ paths: application/json: schema: $ref: '#/components/schemas/EventCorrelationPolicyRuleScreen' - description: Details of the vent correlation policyrule to be created + description: Details of the event correlation policyrule to be created responses: '200': content: @@ -2501,238 +1570,6 @@ paths: summary: Update Event Correlation Policy Rule Configuration (v2.0) tags: - Event Policy - /sdwan/v2.1/api/eventcorrelationpolicyrules/query: - post: - 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/EventCorrelationPolicyRuleQueryV2N1' - description: Details for Event Correlation Policy Rule - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/EventCorrelationPolicyRuleQueryFilterV2N1' - 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: Queries DB for Number of Event Correlation Policy Rules (v2.1) - tags: - - Event Policy - /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/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' - type: array - type: object - description: Successful Operation - summary: Get Event Correlation Policy Rules (v2.1) - tags: - - Event Policy - post: - description: Create the event correlation policy rule configuration. - operationId: post-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 - 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/EventCorrelationPolicyRuleV2N1' - description: Successful Operation - '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.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: ID of the event policy set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: ID of the event policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' - description: Successful Operation - '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 - get: - description: List the event correlation policy rule. - operationId: get-sdwan-v2.1-api-eventcorrelationpolicysets-policy_set_id-eventcorrelationpolicyrules-policy_rule_id - parameters: - - description: ID of the event policy set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: ID of the event policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' - description: Successful Operation - summary: Get Event Correlation Policy Rule (v2.1) - tags: - - Event Policy - 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: ID of the event policy set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: ID of the event policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/EventCorrelationPolicyRuleScreenV2N1' - description: Details of the event correlation policyrule to be updated - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/EventCorrelationPolicyRuleV2N1' - description: Successful Operation - '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: Update Event Correlation Policy Rule Configuration (v2.1) - tags: - - Event Policy servers: - url: https://api.sase.paloaltonetworks.com tags: diff --git a/openapi-specs/sdwan/unified/Events.yaml b/openapi-specs/sdwan/unified/Events.yaml index 3ee8b35a6..b8f903127 100644 --- a/openapi-specs/sdwan/unified/Events.yaml +++ b/openapi-specs/sdwan/unified/Events.yaml @@ -34,21 +34,9 @@ components: type: string Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -62,28 +50,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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: diff --git a/openapi-specs/sdwan/unified/IPFIX.yaml b/openapi-specs/sdwan/unified/IPFIX.yaml index 3fac8ef32..f4caee152 100644 --- a/openapi-specs/sdwan/unified/IPFIX.yaml +++ b/openapi-specs/sdwan/unified/IPFIX.yaml @@ -2,21 +2,9 @@ components: schemas: Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -30,28 +18,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 BulkResponse: properties: count: diff --git a/openapi-specs/sdwan/unified/Metrics.yaml b/openapi-specs/sdwan/unified/Metrics.yaml index a3de1596e..0b5e2de98 100644 --- a/openapi-specs/sdwan/unified/Metrics.yaml +++ b/openapi-specs/sdwan/unified/Metrics.yaml @@ -1,78 +1,5 @@ components: schemas: - Aggregate: - properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array - field: - description: 'The field value. - - ' - type: string - name: - description: 'The name of the query response. - - ' - type: string - operator: - description: 'The operator values. - - ' - enum: - - max - - count - - min - - avg - - sum - type: string - statistic: - description: 'The 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 - AggregateMetric: - properties: - name: - description: 'The name of the aggregate metric. - - ' - type: string - statistic: - description: 'QoS application aggregate statistics. - - ' - type: string - unit: - description: 'The unit. - - ' - type: string - required: - - statistic - - unit - - name AggregateStatsFilter: properties: app: @@ -100,8 +27,7 @@ components: type: string type: array required: - - site - - app + - path AggregateStatsQuery: properties: aggregates: @@ -134,6 +60,9 @@ components: required: - filter - aggregates + - start_time + - name + - end_time AggregateStatsResponse: properties: aggregates: @@ -156,15 +85,10 @@ components: ' format: date type: string - AggregatesQueryResponse: - properties: - aggregates: - description: 'The application QoS aggregates. - - ' - items: - $ref: '#/components/schemas/Aggregate' - type: array + required: + - aggregates + - end_time + - start_time AppObjectStatsResponse: properties: data: @@ -185,7 +109,6 @@ components: - IntfStatistics - CellularModuleStatistics - CellularAPNStatistics - - CellularAPNV6Statistics - MulticastStatistics - SecurityPolicyRule - IntfPoEStatistics @@ -199,6 +122,12 @@ components: start_time: format: date type: string + required: + - filter + - data + - object_type + - end_time + - start_time AppStatsAggregate: properties: name: @@ -216,6 +145,7 @@ components: description: Unit type: string required: + - unit - name AppStatsAggregateData: properties: @@ -246,6 +176,12 @@ components: unit: description: Unit type: string + required: + - unit + - name + - start_time + - end_time + - data AppStatsAggregateFilter: properties: app: @@ -307,6 +243,10 @@ components: start_time: description: "The start time to get the app statistics. \n" type: string + required: + - end_time + - start_time + - aggregates AppStatsAggregatesQuery: properties: aggregates: @@ -338,12 +278,18 @@ components: format: date type: string required: + - filter - aggregates + - start_time + - name + - end_time AppStatsFilter: properties: health_score: description: Health Score type: map[appstatsoperatortype,string] + required: + - health_score AppStatsSupportedAggregate: properties: description: @@ -363,6 +309,10 @@ components: description: Units type: string type: array + required: + - units + - name + - description AppStatsSupportedAggregatesResponse: properties: aggregates: @@ -370,6 +320,8 @@ components: items: $ref: '#/components/schemas/AppStatsSupportedAggregate' type: array + required: + - aggregates AppStatsTopNFilter: properties: app: @@ -476,8 +428,12 @@ components: - egress_audio_mos type: string required: + - filter - topn_basis - top_n + - start_time + - name + - end_time AppStatsTopNResponse: properties: top_n: @@ -485,6 +441,8 @@ components: description: 'The details of the Top N reports. ' + required: + - top_n AppStatsTopNResponseData: properties: end_time: @@ -541,6 +499,13 @@ components: - app - site type: string + required: + - topn_basis + - type + - items + - start_time + - limit + - end_time AppStatsTopNView: properties: limit: @@ -556,200 +521,7 @@ components: type: string required: - type - ApplicationQosAggregatesQuery: - properties: - aggregates: - description: 'The aggregate number of supported app stats. Max number = - 10. - - ' - items: - $ref: '#/components/schemas/AggregateMetric' - type: array - end_time: - description: 'The end time to get the app stats. - - ' - format: date - type: string - filter: - $ref: '#/components/schemas/ApplicationQosMetricsFilter' - 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. - - ' - format: date - type: string - view: - $ref: '#/components/schemas/View' - description: "View the QoS metric details. \n" - required: - - filter - - aggregates - ApplicationQosMetricsFilter: - properties: - application_name: - description: 'Filter by the name of the application. - - ' - type: string - direction: - description: 'Filter by the traffic direction. - - ' - enum: - - Ingress - - Egress - type: string - email: - description: 'Filter by the email address. - - ' - items: - description: Email - type: string - type: array - site: - description: 'Filter by the site. - - ' - items: - description: Site - type: string - type: array - user: - description: "Filter by user. \n" - items: - description: User - type: string - type: array - required: - - application_name - ApplicationQosMetricsQuery: - properties: - end_time: - description: 'The end time to get the application QoS metrics. - - ' - format: date - type: string - filter: - $ref: '#/components/schemas/ApplicationQosMetricsFilter' - description: 'Filters according to the specifications. - - ' - interval: - description: 'The interval time of the application QoS metrics. - - ' - enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day - type: string - max_datapoints: - description: 'The max datapoints of the application QoS metrics. - - ' - format: int32 - type: integer - metrics: - description: 'Details of the application QoS metrics. - - ' - items: - $ref: '#/components/schemas/Metrics' - type: array - name: - description: 'The name of the Application QoS metric. - - ' - type: string - start_time: - description: 'The start time to get the application QoS metrics. - - ' - format: date - type: string - view: - $ref: '#/components/schemas/View' - description: 'View the application QoS metrics. - - ' - required: - - filter - - interval - - metrics - ApplicationQosMetricsResponse: - properties: - metrics: - description: 'Details of the application metrics. - - ' - items: - $ref: '#/components/schemas/Metrics' - type: array - ApplicationUserData: - properties: - client_ip: - description: 'The client IP address. - - ' - type: string - email: - description: 'The email ID of the application user. - - ' - type: string - site: - description: 'The site. - - ' - type: string - user_name: - description: "The user name of the application user. \n" - type: string - ApplicationUsersQuery: - properties: - application_name: - description: 'Filter by application name. - - ' - type: string - end_time: - description: 'Filter by end time. - - ' - format: date - type: string - name: - description: 'Filter by app name. - - ' - type: string - start_time: - description: 'Filter by end time. - - ' - format: date - type: string - required: - - application_name - ApplicationUsersResponse: - properties: - data: - description: Data - items: - $ref: '#/components/schemas/ApplicationUserData' - type: array + - limit BaseTopNQuery: properties: end_time: @@ -787,8 +559,12 @@ components: ' type: string required: + - filter - topn_basis - top_n + - start_time + - name + - end_time BaseTopNResponse: properties: top_n: @@ -796,6 +572,8 @@ components: description: 'The details of the Top N reports. ' + required: + - top_n BaseTopNResponseData: properties: end_time: @@ -833,6 +611,13 @@ components: ' type: string + required: + - topn_basis + - type + - items + - start_time + - limit + - end_time BaseTopNView: properties: limit: @@ -848,6 +633,7 @@ components: type: string required: - type + - limit CapacityPredictionFilter: properties: direction: @@ -872,14 +658,12 @@ 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. @@ -910,8 +694,6 @@ components: - CAPACITY_EXCEED_THRESHOLD - ANOMALY - CIRCUIT_CAPACITY_FORECAST - - CIRCUIT_UTILIZATION - - ANOMALY_SITE_CIRCUIT_DETAILS type: string type: array forecast_date: @@ -941,17 +723,17 @@ 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: "The details of the forecast. \n" type: object @@ -959,13 +741,9 @@ components: 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: @@ -1017,6 +795,13 @@ components: description: Site type: string type: array + required: + - carrier + - apn + - cellular_module + - direction + - site + - element CellularmetricsQuery: properties: end_time: @@ -1036,11 +821,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string max_datapoints: description: 'The max data points. @@ -1076,8 +861,14 @@ components: ' required: + - filter + - view + - max_datapoints - interval - metrics + - start_time + - name + - end_time CellularmetricsResponse: properties: metrics: @@ -1085,6 +876,8 @@ components: items: $ref: '#/components/schemas/Metrics' type: array + required: + - metrics CellularmetricsSchemaResponse: properties: metrics: @@ -1094,6 +887,8 @@ components: items: $ref: '#/components/schemas/MetricSchema' type: array + required: + - metrics ClientDetails: properties: aging_timeout: @@ -1154,6 +949,15 @@ components: ' type: integer + required: + - stats_start_time_ms + - uptime + - reauth_timeout + - vlan_id + - username + - mac_address + - interface_id + - element_id Data: properties: datapoints: @@ -1164,6 +968,9 @@ components: statistics: description: Statistics type: object + required: + - datapoints + - statistics Datapoints: properties: duration: @@ -1183,9 +990,6 @@ components: description: Links type: string type: array - ninetieth_percentile: - description: Ninetieth Percentile - type: number sites: description: 'The sites. @@ -1199,6 +1003,12 @@ components: ' type: number + required: + - filter_property_id + - sites + - links + - value + - duration Error: properties: _error: @@ -1245,11 +1055,143 @@ components: ' type: string - FlowSummary: + 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: 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 @@ -1258,18 +1200,56 @@ 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 @@ -1278,21 +1258,173 @@ 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_v6: - description: Is V6 + is_sec_policy_present: + description: Is Sec Policy Present 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 @@ -1310,39 +1442,257 @@ 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 - sec_policy_actions: - description: Sec Policy Actions + 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 items: - description: Sec Policy Actions + description: Sec Fc App Id 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 + description: 'Service Endpoint Id: JsonInclude(content = ALWAYS, contentFilter + = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) ' 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 - user_name: - description: User Name + unknown_reason: + description: Unknown Reason + 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]) ' type: string - vrf_id: - description: Vrf Id + 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: + - 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: @@ -1382,6 +1732,12 @@ components: description: Source Port type: integer type: array + required: + - source_port + - source_ip + - protocol + - destination_port + - destination_ip Flows: properties: debug_level: @@ -1393,13 +1749,18 @@ components: items: description: "The flow summary information. \n" items: - $ref: '#/components/schemas/FlowSummary' + $ref: '#/components/schemas/FlowDetails' type: array start_time: description: 'The start time to get the flow information. ' type: string + required: + - start_time + - items + - end_time + - debug_level FlowsFilter: properties: app: @@ -1502,6 +1863,19 @@ components: 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: @@ -1535,11 +1909,20 @@ 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: @@ -1548,9 +1931,6 @@ components: ' format: date-time type: string - bw_site_anomaly: - description: Bw Site Anomaly - type: number forecast_status: description: 'The forecast status. True or False. @@ -1571,8 +1951,6 @@ components: - CAPACITY_EXCEED_THRESHOLD - ANOMALY - CIRCUIT_CAPACITY_FORECAST - - CIRCUIT_UTILIZATION - - ANOMALY_SITE_CIRCUIT_DETAILS type: string type: description: 'The type of forecast. @@ -1581,8 +1959,13 @@ 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: @@ -1600,6 +1983,10 @@ components: ' type: string + required: + - direction + - wn_path + - site HealthData: properties: fair: @@ -1620,6 +2007,13 @@ components: type: description: Type type: string + required: + - others + - good + - fair + - poor + - total + - type HealthFilter: properties: application_health: @@ -1658,6 +2052,10 @@ components: - ALL type: string type: array + required: + - application_health + - link_health + - site_health HealthScoreQuery: properties: end_time: @@ -1676,11 +2074,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string name: description: 'The name of the healthscore filter. @@ -1701,6 +2099,13 @@ components: - SUMMARY - TIMESERIES type: string + required: + - view + - filter + - interval + - start_time + - name + - end_time HealthScoreResponse: properties: data: @@ -1719,11 +2124,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string start_time: description: 'The start time to get the health data. @@ -1736,6 +2141,12 @@ components: ' type: object + required: + - view + - data + - end_time + - start_time + - interval LqmStatsAggregateHealthScoreRequest: properties: aggregation: @@ -1773,6 +2184,9 @@ components: required: - healthscore_type - aggregation + - start_time + - name + - end_time LqmStatsAggregateHealthScoreResponse: properties: aggregation: @@ -1806,12 +2220,20 @@ 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: @@ -1831,6 +2253,10 @@ components: - fair - good type: string + required: + - count + - data + - health MetricSchema: properties: description: @@ -1858,6 +2284,11 @@ components: description: Units type: string type: array + required: + - description + - statistics + - units + - name MetricSchemaResponse: properties: metrics: @@ -1867,6 +2298,8 @@ components: items: $ref: '#/components/schemas/MetricSchema' type: array + required: + - metrics Metrics: properties: series: @@ -1876,6 +2309,8 @@ components: items: $ref: '#/components/schemas/Series' type: array + required: + - series MonitorMetricsFilter: properties: anynet_link: @@ -1952,6 +2387,17 @@ 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: @@ -1970,11 +2416,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string max_datapoints: description: 'The max data points. @@ -2004,8 +2450,14 @@ components: ' required: + - filter + - view + - max_datapoints - interval - metrics + - start_time + - name + - end_time MonitorMetricsResponse: properties: metrics: @@ -2015,6 +2467,8 @@ components: items: $ref: '#/components/schemas/Metrics' type: array + required: + - metrics MulticastRouteIncomingInterface: properties: iif: @@ -2032,6 +2486,10 @@ components: ' type: string + required: + - is_site_interface + - wanpath + - iif MulticastRouteOutgoingInterface: properties: is_site_interface: @@ -2050,6 +2508,10 @@ components: description: Wanpaths type: string type: array + required: + - is_site_interface + - wanpaths + - oif MulticastRouteOutgoingInterfaceStatsData: properties: is_site_interface: @@ -2063,6 +2525,10 @@ components: items: $ref: '#/components/schemas/MulticastRouteWanpathStatsData' type: array + required: + - is_site_interface + - wanpaths + - oif MulticastRouteOutgoingInterfaceStatsResponse: properties: end_time: @@ -2076,6 +2542,10 @@ components: start_time: description: Start Time type: string + required: + - start_time + - end_time + - oif_list MulticastRouteSourceGroupStatsData: properties: flags: @@ -2119,6 +2589,14 @@ components: ' type: string + required: + - rx_packets + - rx_bytes + - flags + - outgoing_interfaces + - incoming_interface + - group + - source MulticastRouteSourceGroupStatsResponse: properties: end_time: @@ -2138,6 +2616,10 @@ components: ' type: string + required: + - source_group_list + - start_time + - end_time MulticastRouteStatsFilter: properties: element: @@ -2173,6 +2655,7 @@ components: type: string type: array required: + - group - source - site - element @@ -2217,6 +2700,9 @@ components: - is_active - type - filter + - start_time + - name + - end_time MulticastRouteWanpathStatsData: properties: last_active: @@ -2233,6 +2719,11 @@ components: wanpath: description: Wanpath type: string + required: + - last_active + - tx_packets + - tx_bytes + - wanpath MulticastWANNeighborStatsFilter: properties: element: @@ -2299,6 +2790,9 @@ components: required: - filter - object_type + - start_time + - name + - end_time MulticastWANPIMStatsData: properties: end_time: @@ -2386,6 +2880,22 @@ 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: @@ -2393,6 +2903,8 @@ components: description: 'The multicast WAN PIM statistics. ' + required: + - data MulticastWANPathStats: properties: rx_bytes: @@ -2428,6 +2940,12 @@ components: ' type: string + required: + - rx_bytes + - tx_bytes + - tx_packets + - rx_packets + - wanpath MulticastWANPathStatsData: properties: end_time: @@ -2450,6 +2968,11 @@ components: items: $ref: '#/components/schemas/MulticastWANPathStats' type: array + required: + - wanpath_list + - remote_site_id + - start_time + - end_time MulticastWANPathStatsResponse: properties: data: @@ -2457,6 +2980,8 @@ components: description: 'The multicast WAN path statistics. ' + required: + - data MulticastWANTrafficStatsData: properties: end_time: @@ -2498,6 +3023,14 @@ components: ' format: int64 type: integer + required: + - rx_bytes + - tx_bytes + - tx_packets + - rx_packets + - remote_site_id + - start_time + - end_time MulticastWANTrafficStatsResponse: properties: data: @@ -2505,6 +3038,8 @@ components: description: 'The multicast WAN traffic statistics. ' + required: + - data NetworkPointMetrics: properties: name: @@ -2522,6 +3057,10 @@ components: unit: description: Unit type: string + required: + - sites + - unit + - name NetworkPointMetricsFilter: properties: direction: @@ -2569,6 +3108,13 @@ components: description: Waninterface type: string type: array + required: + - direction + - waninterface + - interface + - site + - sites + - element NetworkPointMetricsQuery: properties: end_time: @@ -2588,11 +3134,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string metrics: description: 'The details of the network point metric. Metrics need to specified @@ -2619,6 +3165,9 @@ components: - filter - metrics - interval + - start_time + - name + - end_time NetworkPointMetricsResponse: properties: interval: @@ -2626,11 +3175,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string metrics: description: 'The details of the network point metric. Metrics need to specified @@ -2653,6 +3202,11 @@ components: description: 'The individual and summary views. ' + required: + - view + - interval + - start_time + - metrics ObjectStatsFilter: properties: element: @@ -2669,8 +3223,6 @@ components: description: Site type: string type: array - required: - - site ObjectStatsQuery: properties: end_time: @@ -2701,7 +3253,6 @@ components: - IntfStatistics - CellularModuleStatistics - CellularAPNStatistics - - CellularAPNV6Statistics - MulticastStatistics - SecurityPolicyRule - IntfPoEStatistics @@ -2722,10 +3273,15 @@ components: - filter - object_id - object_type + - start_time + - name + - end_time ObjectStatsResponse: properties: data: type: object + required: + - data ObjectStatsType: properties: description: @@ -2737,6 +3293,9 @@ components: ' type: string + required: + - description + - name ObjectStatsTypeResponse: properties: object_statistics: @@ -2746,6 +3305,8 @@ components: items: $ref: '#/components/schemas/ObjectStatsType' type: array + required: + - object_statistics PointData: properties: avail_disk: @@ -2865,6 +3426,33 @@ 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: @@ -2877,6 +3465,9 @@ components: description: 'The data of the point metric Anynet. ' + required: + - data + - anynet_link_id PointMetricsQuery: properties: end_time: @@ -2896,11 +3487,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string metrics: description: 'The details of the point metric. Metrics need to specified @@ -2926,6 +3517,14 @@ components: view: $ref: '#/components/schemas/View' description: View + required: + - view + - interval + - filter + - metrics + - start_time + - name + - end_time PointMetricsResponse: properties: interval: @@ -2952,6 +3551,11 @@ components: description: 'The individual and summary views. ' + required: + - start_time + - interval + - view + - metrics PointMetricsSites: properties: data: @@ -2972,6 +3576,10 @@ components: items: $ref: '#/components/schemas/PointMetricsWanPath' type: array + required: + - data + - waninterfaces + - site_id PointMetricsWanPath: properties: anynetlinks: @@ -2991,6 +3599,10 @@ components: ' type: string + required: + - data + - anynetlinks + - wn_path_id QosMetricsFilter: properties: direction: @@ -3044,6 +3656,10 @@ components: required: - traffic_type - priority + - waninterface + - direction + - site + - element QosMetricsQuery: properties: end_time: @@ -3062,11 +3678,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string max_datapoints: description: 'The max data points. @@ -3097,8 +3713,13 @@ components: ' required: - filter + - view + - max_datapoints - interval - metrics + - start_time + - name + - end_time QosMetricsResponse: properties: metrics: @@ -3108,6 +3729,8 @@ components: items: $ref: '#/components/schemas/Metrics' type: array + required: + - metrics RadiusClientMetricsFilter: properties: element: @@ -3128,6 +3751,10 @@ components: description: Site type: string type: array + required: + - site + - interface + - element RadiusClientsRequest: properties: end_time: @@ -3160,8 +3787,14 @@ components: ' format: date type: string - RadiusClientsResponse: - properties: + required: + - max_datapoints + - filter + - start_time + - name + - end_time + RadiusClientsResponse: + properties: end_time: description: "The end time to get the client metrics. If not specified,\ \ it is default to now. End times need to be specified in ISO8601 UTC\ @@ -3181,6 +3814,10 @@ components: ' type: string + required: + - start_time + - items + - end_time RadiusMetricsFilter: properties: client_mac_address: @@ -3223,6 +3860,12 @@ components: description: Site type: string type: array + required: + - client_mac_address + - interface + - direction + - site + - element RadiusMetricsQuery: properties: end_time: @@ -3241,11 +3884,11 @@ components: description: 'Interval: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property) ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string max_datapoints: description: 'The max data points. @@ -3279,8 +3922,14 @@ components: ' required: + - filter + - view + - max_datapoints - interval - metrics + - start_time + - name + - end_time RadiusMetricsResponse: properties: metrics: @@ -3290,6 +3939,48 @@ 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: @@ -3315,6 +4006,12 @@ components: ' type: object + required: + - view + - unit + - name + - interval + - data SysMetricsFilter: properties: direction: @@ -3347,6 +4044,11 @@ components: description: Site type: string type: array + required: + - interface + - direction + - site + - element SysMetricsQuery: properties: end_time: @@ -3365,11 +4067,11 @@ components: ' enum: - - 10sec - - 1min - - 5min - - 1hour - - 1day + - TEN_SEC + - ONE_MIN + - FIVE_MIN + - ONE_HOUR + - ONE_DAY type: string max_datapoints: description: 'The max data points. @@ -3397,8 +4099,14 @@ 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: @@ -3408,6 +4116,8 @@ components: items: $ref: '#/components/schemas/Metrics' type: array + required: + - metrics TopNComparator: properties: end_time: @@ -3435,6 +4145,10 @@ components: ' format: date type: string + required: + - measurement + - end_time + - start_time TopNGrowth: properties: compare: @@ -3462,7 +4176,10 @@ components: type: string required: - metrics + - filter + - compare - type + - limit TopNGrowthFilter: properties: app: @@ -3532,6 +4249,8 @@ components: description: Waninterface type: string type: array + required: + - direction TopNGrowthQuery: properties: end_time: @@ -3557,6 +4276,9 @@ components: ' required: - top_n + - start_time + - name + - end_time View: properties: individual: @@ -3577,9 +4299,6 @@ components: - TRAFFIC_TYPE - COMMON - CLIENT_MAC_ADDRESS - - USER - - USER_EMAIL - - RESOLUTION_QUALITY - None type: string summary: @@ -3587,6 +4306,9 @@ components: ' type: boolean + required: + - individual + - summary info: contact: {} description: List of APIs used to retrieve SDWAN metrics such as badnwidth utilization, @@ -3743,48 +4465,6 @@ paths: summary: Query Radius Metrics Top N (v2.0) tags: - Metrics - /sdwan/v2.0/api/monitor/aggregates/application/qos: - post: - description: Query all the pplication QoS aggregates. - operationId: post-sdwan-v2.0-api-monitor-aggregates-application-qos - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ApplicationQosAggregatesQuery' - description: Filters for application qos aggregates - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AggregatesQueryResponse' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: REQUIRED_PROPERTY - - code: INVALID_STATS_REQUEST_BODY - - code: INVALID_FILTER - - code: APPLICATION_NOT_SUPPORTED - - code: MULTIPLE_QOS_TYPE_NOT_SUPPORTED - - code: REQUESTED_METRIC_NOT_SUPPORTED - - code: REQUESTED_METRIC_UNIT_NOT_SUPPORTED - - code: REQUESTED_METRIC_STATISTICS_NOT_SUPPORTED - - code: REQUESTED_VIEW_NOT_SUPPORTED - - code: START_TIME_GREATER_THAN_END_TIME - - code: OTHER_METRICS_NOT_SUPPORTED - - code: REQUESTED_VIEW_NOT_SUPPORTED_FOR_METRIC - - code: SERVICE_UNAVAILABLE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Application QoS Aggregates (v2.0) - tags: - - Metrics /sdwan/v2.0/api/monitor/aggregates/multicast/mroute: post: description: Query all the multicast statistics. @@ -3886,7 +4566,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Get site or path level aggregated statistics (v2.0) + summary: Get site or path level aggregated statistics tags: - Metrics post: @@ -3929,61 +4609,6 @@ paths: 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. @@ -4044,7 +4669,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Capacity Prediction (v2.0) + summary: Get Capacity Prediction tags: - Metrics /sdwan/v2.0/api/monitor/aiops/health: @@ -4198,116 +4823,6 @@ paths: summary: Get TopN Data with Metrics Output (v2.0) tags: - Metrics - /sdwan/v2.0/api/monitor/application/qos_metrics: - post: - description: Query the time series application QoS metrics. - operationId: post-sdwan-v2.0-api-monitor-application-qos_metrics - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ApplicationQosMetricsQuery' - description: Filters for application qos metrics - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ApplicationQosMetricsResponse' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: REQUIRED_PROPERTY - - code: INVALID_STATS_REQUEST_BODY - - code: INVALID_FILTER - - code: APPLICATION_NOT_SUPPORTED - - code: MULTIPLE_QOS_TYPE_NOT_SUPPORTED - - code: REQUESTED_METRIC_NOT_SUPPORTED - - code: REQUESTED_METRIC_UNIT_NOT_SUPPORTED - - code: REQUESTED_METRIC_STATISTICS_NOT_SUPPORTED - - code: MAX_DATAPOINTS_NOT_SUPPORTED - - code: REQUESTED_VIEW_NOT_SUPPORTED - - code: START_TIME_GREATER_THAN_END_TIME - - code: OTHER_METRICS_NOT_SUPPORTED - - code: REQUESTED_VIEW_NOT_SUPPORTED_FOR_METRIC - - code: MOS_METRICS_NOT_SUPPORTED - - code: SERVICE_UNAVAILABLE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Time Series Application QoS Metrics (v2.0) - tags: - - Metrics - /sdwan/v2.0/api/monitor/application/qos_metrics/{application_name}: - get: - description: Get details of application QoS metrics. - operationId: get-sdwan-v2.0-api-monitor-application-qos_metrics-application_name - parameters: - - description: The name of the application. - in: path - name: application_name - required: true - schema: - description: Application Name - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/MetricSchemaResponse' - description: Successful Operation - '404': - content: - application/json: - example: - value: - _error: - - code: APPLICATION_NOT_SUPPORTED - schema: - $ref: '#/components/schemas/Error' - description: Not Found - summary: Get Application QoS Metrics (v2.0) - tags: - - Metrics - /sdwan/v2.0/api/monitor/application/users: - post: - description: Query the application user list. - operationId: post-sdwan-v2.0-api-monitor-application-users - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ApplicationUsersQuery' - description: Filters for application qos point metrics - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ApplicationUsersResponse' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: REQUIRED_PROPERTY - - code: INVALID_STATS_REQUEST_BODY - - code: APPLICATION_NOT_SUPPORTED - - code: START_TIME_GREATER_THAN_END_TIME - - code: SERVICE_UNAVAILABLE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Application Users (v2.0) - tags: - - Metrics /sdwan/v2.0/api/monitor/cellular_metrics: get: description: List all the cellular metrics schema. @@ -4391,7 +4906,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Cellular metrics for Version 2.0 (v2.0) + summary: Cellular metrics for Version 2.0 tags: - Metrics /sdwan/v2.0/api/monitor/cellular_metrics/topn: @@ -4588,6 +5103,62 @@ paths: summary: Query Network Point Metrics Health Score (v2.0) tags: - Metrics + /sdwan/v2.0/api/monitor/object_stats: + get: + description: Get object stats API v2.0 + operationId: get-sdwan-v2.0-api-monitor-object_stats + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStatsTypeResponse' + description: Successful Operation + summary: Get name and description of all object stats + tags: + - Metrics + post: + description: Query all the object statistics. + operationId: post-sdwan-v2.0-api-monitor-object_stats + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStatsQuery' + description: Details of 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 Object Stats (v2.0) + tags: + - Metrics /sdwan/v2.0/api/monitor/qos_metrics: get: description: Get details of QoS metrics. @@ -4636,12 +5207,79 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Qos metrics (v2.0) + summary: Query Qos metrics tags: - Metrics - /sdwan/v2.0/api/monitor/sys_metrics/topn: - post: - description: Query the details of the system metrics Top N. + /sdwan/v2.0/api/monitor/sys_metrics: + get: + description: 'Returns sysmetrics schema for Version 2.0 + + ' + operationId: get-sdwan-v2.0-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.0 + tags: + - Metrics + post: + description: Query the details of the system metrics schema. + operationId: post-sdwan-v2.0-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: 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: Query System Metrics Schema (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: @@ -4754,66 +5392,6 @@ paths: 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. @@ -4930,22 +5508,22 @@ paths: summary: Query App Object Statistics (v2.1) tags: - Metrics - /sdwan/v2.1/api/monitor/sys_metrics/topn: + /sdwan/v2.1/api/monitor/metrics: post: - description: Query the details of the system metrics Top N. - operationId: post-sdwan-v2.1-api-monitor-sys_metrics-topn + description: Query the monitor metrics + operationId: post-sdwan-v2.1-api-monitor-metrics requestBody: content: application/json: schema: - $ref: '#/components/schemas/BaseTopNQuery' - description: Filter for top N + $ref: '#/components/schemas/MonitorMetricsQuery' + description: Details of monitor metrics query responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BaseTopNResponse' + $ref: '#/components/schemas/MonitorMetricsResponse' description: Successful Operation '400': content: @@ -4954,30 +5532,134 @@ paths: 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: 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: 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 + - 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 System Metrics Top N (v2.1) + summary: Query Monitor Metrics (v2.1) tags: - Metrics - /sdwan/v2.2/api/monitor/sys_metrics: + /sdwan/v2.1/api/monitor/metrics/{mtype}: get: - description: 'Returns sysmetrics schema for Version 2.2 + description: List details of the monitor metrics. + operationId: get-sdwan-v2.1-api-monitor-metrics-mtype + parameters: + - 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.1) + tags: + - Metrics + /sdwan/v2.1/api/monitor/object_stats: + get: + description: Get object stats API v2.1 + operationId: get-sdwan-v2.1-api-monitor-object_stats + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStatsTypeResponse' + description: Successful Operation + summary: Get name and description of all object stats + tags: + - Metrics + post: + description: Query all the object statistics. + operationId: post-sdwan-v2.1-api-monitor-object_stats + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStatsQuery' + description: Details of 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 Object Stats (v2.1) + tags: + - Metrics + /sdwan/v2.1/api/monitor/sys_metrics: + get: + description: 'Returns sysmetrics schema for Version 2.1 ' - operationId: get-sdwan-v2.2-api-monitor-sys_metrics + operationId: get-sdwan-v2.1-api-monitor-sys_metrics responses: '200': content: @@ -4991,12 +5673,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Returns sysmetrics schema for Version 2.2 (v2.2) + summary: Returns sysmetrics schema for Version 2.1 tags: - Metrics post: - description: List all the system metrics schema. - operationId: post-sdwan-v2.2-api-monitor-sys_metrics + description: List the details of the system metrics schema. + operationId: post-sdwan-v2.1-api-monitor-sys_metrics requestBody: content: application/json: @@ -5037,13 +5719,55 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Get System Metrics Schema (v2.2) + summary: Get System Metrics Schema (v2.1) tags: - Metrics - /sdwan/v2.3/api/monitor/metrics: + /sdwan/v2.1/api/monitor/sys_metrics/topn: post: - description: Query all the monitor metrics. - operationId: post-sdwan-v2.3-api-monitor-metrics + 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': + 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) + tags: + - Metrics + /sdwan/v2.2/api/monitor/metrics: + post: + description: Query the monitor metrics. + operationId: post-sdwan-v2.2-api-monitor-metrics requestBody: content: application/json: @@ -5068,7 +5792,6 @@ 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 @@ -5095,13 +5818,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Monitor Metrics (v2.3) + summary: Query Monitor Metrics (v2.1) tags: - Metrics - /sdwan/v2.3/api/monitor/metrics/{mtype}: + /sdwan/v2.2/api/monitor/metrics/{mtype}: get: - description: List all the details of the monitor metrics. - operationId: get-sdwan-v2.3-api-monitor-metrics-mtype + description: List details of the monitor metrics. + operationId: get-sdwan-v2.2-api-monitor-metrics-mtype parameters: - description: The metric type. in: path @@ -5127,13 +5850,71 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Monitor Metrics (v2.3) + summary: Get Monitor Metrics (v2.2) tags: - Metrics - /sdwan/v2.3/api/monitor/sys_metrics: + /sdwan/v2.2/api/monitor/object_stats: get: - description: List all the system metrics schema. - operationId: get-sdwan-v2.3-api-monitor-sys_metrics + description: Get object stats API v2.2 + operationId: get-sdwan-v2.2-api-monitor-object_stats + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStatsTypeResponse' + description: Successful Operation + summary: Get name and description of all object statistics + tags: + - Metrics + post: + description: List the object statistics. + operationId: post-sdwan-v2.2-api-monitor-object_stats + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStatsQuery' + description: Details of 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: Get Object Stats (v2.2) + tags: + - Metrics + /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: @@ -5147,12 +5928,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Get System Metrics Schema (v2.3) + summary: Returns sysmetrics schema for Version 2.2 tags: - Metrics post: description: List all the system metrics schema. - operationId: post-sdwan-v2.3-api-monitor-sys_metrics + operationId: post-sdwan-v2.2-api-monitor-sys_metrics requestBody: content: application/json: @@ -5193,13 +5974,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Get System Metrics Schema (v2.3) + summary: Get System Metrics Schema (v2.2) tags: - Metrics - /sdwan/v2.4/api/monitor/metrics: + /sdwan/v2.3/api/monitor/metrics: post: description: Query all the monitor metrics. - operationId: post-sdwan-v2.4-api-monitor-metrics + operationId: post-sdwan-v2.3-api-monitor-metrics requestBody: content: application/json: @@ -5248,17 +6029,16 @@ 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.4) + summary: Query Monitor Metrics (v2.3) tags: - Metrics - /sdwan/v2.4/api/monitor/metrics/{mtype}: + /sdwan/v2.3/api/monitor/metrics/{mtype}: get: description: List all the details of the monitor metrics. - operationId: get-sdwan-v2.4-api-monitor-metrics-mtype + operationId: get-sdwan-v2.3-api-monitor-metrics-mtype parameters: - description: The metric type. in: path @@ -5284,13 +6064,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Monitor Metrics (v2.4) + summary: Get Monitor Metrics (v2.3) tags: - Metrics - /sdwan/v2.4/api/monitor/object_stats: + /sdwan/v2.3/api/monitor/object_stats: get: - description: List details of the object statistics. - operationId: get-sdwan-v2.4-api-monitor-object_stats + description: Get object stats API v2.3 + operationId: get-sdwan-v2.3-api-monitor-object_stats responses: '200': content: @@ -5298,12 +6078,12 @@ paths: schema: $ref: '#/components/schemas/ObjectStatsTypeResponse' description: Successful Operation - summary: Get Object Stats (v2.4) + summary: Get name and description of all object statistics tags: - Metrics post: - description: List details of the object statistics. - operationId: post-sdwan-v2.4-api-monitor-object_stats + description: List the object statistics. + operationId: post-sdwan-v2.3-api-monitor-object_stats requestBody: content: application/json: @@ -5340,13 +6120,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Object Stats (v2.4) + summary: Get Object Stats (v2.3) tags: - Metrics - /sdwan/v2.5/api/monitor/object_stats: + /sdwan/v2.4/api/monitor/object_stats: get: description: List details of the object statistics. - operationId: get-sdwan-v2.5-api-monitor-object_stats + operationId: get-sdwan-v2.4-api-monitor-object_stats responses: '200': content: @@ -5354,12 +6134,12 @@ paths: schema: $ref: '#/components/schemas/ObjectStatsTypeResponse' description: Successful Operation - summary: Get Object Stats (v2.5) + summary: Get Object Stats (v2.4) tags: - Metrics post: - description: Query details of the object statistics. - operationId: post-sdwan-v2.5-api-monitor-object_stats + description: List details of the object statistics. + operationId: post-sdwan-v2.4-api-monitor-object_stats requestBody: content: application/json: @@ -5396,7 +6176,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Object Stats (v2.5) + summary: Get Object Stats (v2.4) tags: - Metrics /sdwan/v3.0/api/monitor/aggregates: @@ -5449,7 +6229,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Aggregate App stats (v3.0) + summary: Aggregate App stats tags: - Metrics /sdwan/v3.0/api/monitor/topn: @@ -5535,10 +6315,57 @@ paths: summary: Get Top N Data (v3.1) tags: - Metrics - /sdwan/v3.7/api/monitor/flows: + /sdwan/v3.4/api/monitor/flows: + post: + description: List all the flow information. + operationId: post-sdwan-v3.4-api-monitor-flows + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FlowsQuery' + description: Filter for flows + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FlowsQueryResponse' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: EMPTY_REQ_BODY + - code: SCHEMA_MISMATCH + - code: START_TIME_GREATER_THAN_END_TIME + - code: INVALID_REQUEST_ERROR_0001 + - code: EMPTY_FILTER + - code: PATH_AND_PATH_TYPE_NOT_SUPPORTED + - code: SITE_WITH_PATH_MISSING + - code: SITE_WITH_WANINTERFACE_MISSING + - code: SITE_WITH_ELEMENT_MISSING + - code: SITE_WITH_FLOW_TUPLE_MISSING + - code: INVALID_IP + - code: INVALID_FLOW_TYPE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal Server Error + summary: Get Flow Information (v3.4) + tags: + - Metrics + /sdwan/v3.5/api/monitor/flows: post: - description: List all the flows information. - operationId: post-sdwan-v3.7-api-monitor-flows + description: List all the flow information. + operationId: post-sdwan-v3.5-api-monitor-flows requestBody: content: application/json: @@ -5579,13 +6406,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Get Flows Information (v3.7) + summary: Get Flow Information (v3.5) tags: - Metrics - /sdwan/v3.8/api/monitor/flows: + /sdwan/v3.6/api/monitor/flows: post: - description: List all the flows information. - operationId: post-sdwan-v3.8-api-monitor-flows + description: List all the flow information. + operationId: post-sdwan-v3.6-api-monitor-flows requestBody: content: application/json: @@ -5626,7 +6453,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal Server Error - summary: Get Flows Information (v3.8) + summary: Get Flow Information (v3.6) tags: - Metrics servers: diff --git a/openapi-specs/sdwan/unified/Multicast.yaml b/openapi-specs/sdwan/unified/Multicast.yaml index 5224bea49..f92a6dad1 100644 --- a/openapi-specs/sdwan/unified/Multicast.yaml +++ b/openapi-specs/sdwan/unified/Multicast.yaml @@ -2,21 +2,9 @@ components: schemas: Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -30,28 +18,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 DynamicRp: properties: groups: diff --git a/openapi-specs/sdwan/unified/NATPolicy.yaml b/openapi-specs/sdwan/unified/NATPolicy.yaml index 6d75a320e..d155a9f1f 100644 --- a/openapi-specs/sdwan/unified/NATPolicy.yaml +++ b/openapi-specs/sdwan/unified/NATPolicy.yaml @@ -2,21 +2,9 @@ components: schemas: Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -30,28 +18,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 BasePolicyPrefixS: properties: description: @@ -69,12 +35,6 @@ components: description: Ipv4 Prefixes type: string type: array - ipv6_prefixes: - description: Ipv6 Prefixes - items: - description: Ipv6 Prefixes - type: string - type: array name: description: "The name of the source/destination prefix. \n" type: string diff --git a/openapi-specs/sdwan/unified/NetworkConstructs.yaml b/openapi-specs/sdwan/unified/NetworkConstructs.yaml index 530415b45..62983e850 100644 --- a/openapi-specs/sdwan/unified/NetworkConstructs.yaml +++ b/openapi-specs/sdwan/unified/NetworkConstructs.yaml @@ -2,21 +2,9 @@ components: schemas: Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -30,28 +18,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 BaseCustomDHCPOptions: properties: option_definition: @@ -237,9 +203,6 @@ 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. @@ -247,9 +210,6 @@ components: ' format: int32 type: integer - lifetime_units: - description: Lifetime Units - type: string mode: description: 'The IPsec config ESP tunnel mode. @@ -265,10 +225,8 @@ components: items: $ref: '#/components/schemas/Proposals' type: array - responder_sase_proposals: - $ref: '#/components/schemas/ResponderSaseProposals' - description: Responder Sase Proposals required: + - proposals - mode Error: properties: @@ -296,9 +254,6 @@ components: ' type: boolean - authentication_multiple: - description: Authentication Multiple - type: integer key_exchange: description: 'The key exchange for the IKE group = IKEv1 or IKEv2. @@ -314,9 +269,6 @@ 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 @@ -341,6 +293,7 @@ components: ' type: boolean required: + - proposals - key_exchange IKEV1Params: properties: @@ -392,12 +345,6 @@ 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 ' @@ -414,34 +361,18 @@ 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. @@ -467,9 +398,6 @@ 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. @@ -714,6 +642,41 @@ components: - ike_group - esp_group - name + LANNetwork: + properties: + id: + description: "The ID of the LAN network. \n" + type: string + ipv4_config: + $ref: '#/components/schemas/LanNetworkIPv4Config' + description: 'The Ipv4 config of the LAN network. Maz size = 256. + + ' + name: + description: 'The name of the LAN network. Max size = 128. + + ' + type: string + network_context_id: + description: 'The network context ID. + + ' + type: string + scope: + description: "The scope of the network. \n" + enum: + - GLOBAL + - LOCAL + type: string + security_policy_set: + $ref: '#/components/schemas/SecurityPolicySet' + description: 'The details of the security policy set configured for the + network. + + ' + required: + - scope + - name LANNetworkQuery: properties: aggregate: @@ -784,6 +747,41 @@ components: ' format: int64 type: integer + LANNetworkQueryFilter: + properties: + id: + description: "The ID of the LAN network. \n" + type: string + ipv4_config: + $ref: '#/components/schemas/LanNetworkIPv4Config' + description: 'The Ipv4 config of the LAN network. Maz size = 256. + + ' + name: + description: 'The name of the LAN network. Max size = 128. + + ' + type: string + network_context_id: + description: 'The network context ID. + + ' + type: string + scope: + description: "The scope of the network. \n" + enum: + - GLOBAL + - LOCAL + type: string + security_policy_set: + $ref: '#/components/schemas/SecurityPolicySet' + description: 'The details of the security policy set configured for the + network. + + ' + required: + - scope + - name LANNetworkQueryFilterResponse: properties: description: @@ -834,7 +832,7 @@ components: - site_id - scope - name - LANNetworkQueryFilterV3N2: + LANNetworkQueryFilterV3N1: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -847,11 +845,6 @@ 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. @@ -883,12 +876,8 @@ components: required: - scope - name - LANNetworkQueryFilterV3N3: + LANNetworkScreen: properties: - description: - description: 'The description of the LAN network. Maz size = 256. - - ' id: description: "The ID of the LAN network. \n" type: string @@ -896,11 +885,6 @@ 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. @@ -913,34 +897,22 @@ components: ' type: string scope: - description: 'The scope of the network. - - ' + description: "The scope of the network. \n" enum: - GLOBAL - 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. + security_policy_set: + $ref: '#/components/schemas/SecurityPolicySet' + description: 'The details of the security policy set configured for the + network. ' - items: - description: Tags - type: string - type: array - vrf_context_id: - description: "The vrf context id. \n" - type: string required: - scope - name - LANNetworkScreenV3N2: + LANNetworkScreenV3: properties: - description: - description: 'The description of the LAN network. Maz size = 256. - - ' id: description: "The ID of the LAN network. \n" type: string @@ -948,11 +920,6 @@ 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. @@ -972,19 +939,10 @@ components: - GLOBAL - 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. - - ' - items: - description: Tags - type: string - type: array required: - scope - name - LANNetworkScreenV3N3: + LANNetworkScreenV3N1: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -997,11 +955,6 @@ 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. @@ -1022,27 +975,17 @@ 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. - - ' + description: "An information field that can be added to identify the LAN\ + \ network. Maximum 10 unique tags of length 1024 each are allowed. \n" items: description: Tags type: string type: array - vrf_context_id: - description: "The VRF (Virtual Routing and Forwarding) ID. \ - \ \n" - type: string required: - scope - name - LANNetworkV3N2: + LANNetworkV3: properties: - description: - description: 'The description of the LAN network. Maz size = 256. - - ' id: description: "The ID of the LAN network. \n" type: string @@ -1050,11 +993,6 @@ 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. @@ -1074,19 +1012,10 @@ components: - GLOBAL - 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. - - ' - items: - description: Tags - type: string - type: array required: - scope - name - LANNetworkV3N3: + LANNetworkV3N1: properties: description: description: 'The description of the LAN network. Maz size = 256. @@ -1099,11 +1028,6 @@ 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. @@ -1132,11 +1056,6 @@ components: description: Tags type: string type: array - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. - - ' - type: string required: - scope - name @@ -1189,33 +1108,6 @@ components: description: Prefixes type: string type: array - LanNetworkIPv6Config: - properties: - default_routers: - description: 'The LAN config default routers. - - ' - items: - description: Default Routers - type: string - type: array - prefixes: - description: 'The LAN config IPv6 prefix. - - ' - items: - description: Prefixes - type: string - type: array - Lifesize: - properties: - units: - description: Units - type: string - value: - description: Value - format: int32 - type: integer ListQueryResponse: properties: count: @@ -1362,7 +1254,6 @@ components: - AES128CTR - AES192CTR - AES256CTR - - AES128CCM16 - AES128CCM64 - AES192CCM64 - AES256CCM64 @@ -1372,10 +1263,8 @@ components: - AES128CCM128 - AES192CCM128 - AES256CCM128 - - AES128GCM16 - AES128GCM64 - AES192GCM64 - - AES256GCM16 - AES256GCM64 - AES128GCM96 - AES192GCM96 @@ -1415,116 +1304,35 @@ components: - AES128GMAC - AES192GMAC - AES256GMAC - - NONE type: string required: - hash - encryption - dh_groups - ResponderSaseProposals: + SecurityPolicySet: 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. + description: + description: 'The description of the security policy set. Max size = 256. ' - 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. + id: + description: 'The security policy set ID. + + ' + type: string + name: + description: 'The name of the security policy set. Max size = 128. ' + type: string + policyrule_order: + description: "The order for the execution of the policy rule. \n" items: - description: Hash - enum: - - MD5 - - SHA1 - - SHA256 - - SHA384 - - SHA512 - - SHA256_96 - - AESXCBC - - AES128GMAC - - AES192GMAC - - AES256GMAC - - NONE + description: Policyrule Order type: string type: array + required: + - name SiteIPFixPrefixAssociation: properties: id: @@ -1567,6 +1375,7 @@ components: type: string required: - ip_address + - mac - name VPNLinkConfiguration: properties: @@ -1583,6 +1392,23 @@ components: required: - keep_alive_failure_count - keep_alive_interval + WANInterfaceLabel: + properties: + description: + description: 'The description of the WAN interface label. Maz size = 256. + + ' + id: + description: 'The ID of the WAN interface label. + + ' + type: string + label: + description: "The label of the WAN interface. \n" + type: string + name: + description: "The name of the WAN interface label. Max size = 128. \n" + type: string WANInterfaceLabelQuery: properties: aggregate: @@ -1708,7 +1534,26 @@ components: description: 'The configuration of the VPN link. ' - WANInterfaceLabelScreenV2N3: + WANInterfaceLabelScreen: + properties: + description: + description: 'The description of the WAN interface label. Maz size = 256. + + ' + id: + description: 'The ID of the WAN interface label. + + ' + type: string + label: + description: "The label of the WAN interface. \n" + type: string + name: + description: 'The name of the WAN interface label. Max size = 128. + + ' + type: string + WANInterfaceLabelScreenV2N1: properties: description: description: 'The description of the WAN interface label. Maz size = 256. @@ -1736,25 +1581,8 @@ components: description: Tags type: string type: array - use_for_application_reachability_probes: - description: "Indicates if the use for application reachability probe is\ - \ selected. \n" - type: boolean - use_for_controller_connections: - description: 'Indicates if the use for controller connections is selected. - - ' - type: boolean - vpnlink_configuration: - $ref: '#/components/schemas/VPNLinkConfiguration' - description: 'The configuration of the VPN link. - - ' - WANInterfaceLabelScreenV2N4: + WANInterfaceLabelScreenV2N2: properties: - bwc_enabled: - description: "The bwc parameters. \n" - type: boolean description: description: 'The description of the WAN interface label. Maz size = 256. @@ -1765,13 +1593,8 @@ components: ' type: string label: - description: 'The label of the WAN interface. - - ' + description: "The label of the WAN interface. \n" type: string - lqm_enabled: - description: "The link quality monitoring parameters. \n" - type: boolean name: description: 'The name of the WAN interface label. Max size = 128. @@ -1786,10 +1609,93 @@ components: description: Tags type: string type: array - use_for_application_reachability_probes: - description: "Indicates if the use for application reachability probe is\ - \ selected. \n" - type: boolean + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + WANInterfaceLabelScreenV2N3: + properties: + description: + description: 'The description of the WAN interface label. Maz size = 256. + + ' + id: + description: 'The ID of the WAN interface label. + + ' + type: string + label: + description: "The label of the WAN interface. \n" + type: string + name: + description: 'The name of the WAN interface label. Max size = 128. + + ' + type: string + tags: + description: 'An information field that can be added to identify the WAN + interface label. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + use_for_application_reachability_probes: + description: "Indicates if the use for application reachability probe is\ + \ selected. \n" + type: boolean + use_for_controller_connections: + description: 'Indicates if the use for controller connections is selected. + + ' + type: boolean + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + WANInterfaceLabelScreenV2N4: + properties: + bwc_enabled: + description: "The bwc parameters. \n" + type: boolean + description: + description: 'The description of the WAN interface label. Maz size = 256. + + ' + id: + description: 'The ID of the WAN interface label. + + ' + type: string + label: + description: 'The label of the WAN interface. + + ' + type: string + lqm_enabled: + description: "The link quality monitoring parameters. \n" + type: boolean + name: + description: 'The name of the WAN interface label. Max size = 128. + + ' + type: string + tags: + description: 'An information field that can be added to identify the WAN + interface label. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + use_for_application_reachability_probes: + description: "Indicates if the use for application reachability probe is\ + \ selected. \n" + type: boolean use_for_controller_connections: description: 'Indicates if the use for controller connections is selected. @@ -1804,6 +1710,67 @@ components: $ref: '#/components/schemas/VPNLinkConfiguration' description: 'The configuration of the VPN link. + ' + WANInterfaceLabelV2N1: + properties: + description: + description: 'The description of the WAN interface label. Maz size = 256. + + ' + id: + description: 'The ID of the WAN interface label. + + ' + type: string + label: + description: "The label of the WAN interface. \n" + type: string + name: + description: 'The name of the WAN interface label. Max size = 128. + + ' + type: string + tags: + description: 'An information field that can be added to identify the WAN + interface label. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + WANInterfaceLabelV2N2: + properties: + description: + description: 'The description of the WAN interface label. Maz size = 256. + + ' + id: + description: 'The ID of the WAN interface label. + + ' + type: string + label: + description: "The label of the WAN interface. \n" + type: string + name: + description: 'The name of the WAN interface label. Max size = 128. + + ' + type: string + tags: + description: 'An information field that can be added to identify the WAN + interface label. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + ' WANInterfaceLabelV2N3: properties: @@ -2629,41 +2596,53 @@ paths: summary: Update LAN Segment (v2.0) tags: - Network Constructs - /sdwan/v2.0/api/wannetworks: + /sdwan/v2.0/api/sites/{site_id}/lannetworks: get: - description: List all the tenant WAN networks. - operationId: get-sdwan-v2.0-api-wannetworks + description: List all the LAN networks. + operationId: get-sdwan-v2.0-api-sites-site_id-lannetworks + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string responses: '200': content: application/json: schema: - allOf: + oneOf: + - $ref: '#/components/schemas/ListQueryResponse' - $ref: '#/components/schemas/BulkResponse' - - properties: - items: - items: - $ref: '#/components/schemas/WANNetwork' - type: array - type: object description: Successful Operation - summary: Get WAN Networks (v2.0) + summary: Get LAN Networks (v2.0) tags: - Network Constructs post: - description: Create a new WAN network. - operationId: post-sdwan-v2.0-api-wannetworks + description: Create a new LAN segment. + operationId: post-sdwan-v2.0-api-sites-site_id-lannetworks + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/WANNetworkScreen' + $ref: '#/components/schemas/LANNetworkScreen' + description: Details of the network to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANNetwork' + $ref: '#/components/schemas/LANNetwork' description: Successful Operation '400': content: @@ -2673,22 +2652,39 @@ paths: _error: - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_INPUT - - code: EXTRA_PROVIDER_ASNUM + - code: NO_LAN_NET_PREFIX + - code: ONLY_ONE_DEFAULT_ROUTER_SUPPORTED + - code: INVALID_NETWORK_CONTEXT + - code: INVALID_IPV4_PREFIX + - code: SAME_IPV4_PREFIX + - code: INVALID_IPADDRESS + - code: DEFAULT_ROUTER_PREFIX_MISMATCH + - code: SAME_IPV4_DEFAULT_ROUTER_ADDRESS + - code: INVALID_APP_ID + - code: LAN_NETWORK_ADD_FAILURE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create WAN Network (v2.0) + summary: Create LAN Segment (v2.0) tags: - Network Constructs - /sdwan/v2.0/api/wannetworks/query: + /sdwan/v2.0/api/sites/{site_id}/lannetworks/query: post: - description: Query the DB for WAN networks that match query parameters. - operationId: post-sdwan-v2.0-api-wannetworks-query + description: Query LAN networks that match query parameters. + operationId: post-sdwan-v2.0-api-sites-site_id-lannetworks-query + parameters: + - description: The ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/WANNetworkQuery' + $ref: '#/components/schemas/LANNetworkQuery' responses: '200': content: @@ -2699,41 +2695,38 @@ paths: - properties: items: items: - $ref: '#/components/schemas/WANNetworkQuery' + $ref: '#/components/schemas/LANNetworkQueryFilter' type: array type: object description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_WAN_NETWORK_EXISTS - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query DB for WAN Networks (v2.0) + summary: Query LAN Networks (v2.0) tags: - Network Constructs - /sdwan/v2.0/api/wannetworks/{wan_network_id}: + /sdwan/v2.0/api/sites/{site_id}/lannetworks/{lannetwork_id}: delete: - description: Delete an existing WAN network. - operationId: delete-sdwan-v2.0-api-wannetworks-wan_network_id + description: Delete an existing LAN network. + operationId: delete-sdwan-v2.0-api-sites-site_id-lannetworks-lannetwork_id parameters: - - description: The ID of the WAN network. + - description: The ID of the site. in: path - name: wan_network_id + name: site_id required: true schema: - description: Wan Network Id + description: Site Id + type: string + - description: The ID of the LAN network. + in: path + name: lannetwork_id + required: true + schema: + description: Lannetwork Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANNetwork' + $ref: '#/components/schemas/LANNetwork' description: Successful Operation '400': content: @@ -2741,30 +2734,372 @@ paths: example: value: _error: - - code: SITE_WAN_NETWORK_EXISTS + - code: LAN_NETWORK_IN_USE + - code: LANNETWORK_IS_USED_IN_SECURITY_ZONES schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete WAN Network (v2.0) + summary: Delete LAN Network (v2.0) tags: - Network Constructs get: - description: List a WAN network. - operationId: get-sdwan-v2.0-api-wannetworks-wan_network_id + description: List a LAN network. + operationId: get-sdwan-v2.0-api-sites-site_id-lannetworks-lannetwork_id parameters: - - description: The ID of the WAN network. + - description: The ID of the site. in: path - name: wan_network_id + name: site_id required: true schema: - description: Wan Network Id + description: Site Id type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/WANNetwork' + - description: The ID of the LAN network. + in: path + name: lannetwork_id + required: true + schema: + description: Lannetwork Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LANNetwork' + description: Successful Operation + summary: Get LAN Network (v2.0) + tags: + - Network Constructs + put: + description: Update an existing LAN network. + operationId: put-sdwan-v2.0-api-sites-site_id-lannetworks-lannetwork_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 LAN network. + in: path + name: lannetwork_id + required: true + schema: + description: Lannetwork Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LANNetworkScreen' + description: Details of the network to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LANNetwork' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: INVALID_JSON_INPUT + - code: NO_LAN_NET_PREFIX + - code: ONLY_ONE_DEFAULT_ROUTER_SUPPORTED + - code: INVALID_NETWORK_CONTEXT + - code: INVALID_IPV4_PREFIX + - code: SAME_IPV4_PREFIX + - code: INVALID_IPADDRESS + - code: DEFAULT_ROUTER_PREFIX_MISMATCH + - code: SAME_IPV4_DEFAULT_ROUTER_ADDRESS + - code: INVALID_APP_ID + - code: OVERLAPPING_LAN_NET_PREFIXES + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update LAN Network (v2.0) + tags: + - Network Constructs + /sdwan/v2.0/api/waninterfacelabels: + get: + description: List all the WAN interface labels for a tenant. + operationId: get-sdwan-v2.0-api-waninterfacelabels + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceLabel' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get WAN Interface Labels (v2.0) + tags: + - Network Constructs + /sdwan/v2.0/api/waninterfacelabels/query: + post: + description: Query the DB for WAN interface labels that match query parameters. + operationId: post-sdwan-v2.0-api-waninterfacelabels-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceLabelQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceLabelQuery' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for WAN Interface Labels (v2.0) + tags: + - Network Constructs + /sdwan/v2.0/api/waninterfacelabels/{wantinterface_label_id}: + get: + description: List a specific WAN interface label. + operationId: get-sdwan-v2.0-api-waninterfacelabels-wantinterface_label_id + parameters: + - description: The ID of the WAN interface label. + in: path + name: wantinterface_label_id + required: true + schema: + description: Wantinterface Label Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceLabel' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get WAN Interface Label (v2.0) + tags: + - Network Constructs + put: + description: Update a specific WAN interface label. + operationId: put-sdwan-v2.0-api-waninterfacelabels-wantinterface_label_id + parameters: + - description: The ID of the WAN interface label. + in: path + name: wantinterface_label_id + required: true + schema: + description: Wantinterface Label Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceLabelScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceLabel' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: WAN_INTERFACE_LABEL_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update WAN Interface Label (v2.0) + tags: + - Network Constructs + /sdwan/v2.0/api/wannetworks: + get: + description: List all the tenant WAN networks. + operationId: get-sdwan-v2.0-api-wannetworks + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANNetwork' + type: array + type: object + description: Successful Operation + summary: Get WAN Networks (v2.0) + tags: + - Network Constructs + post: + description: Create a new WAN network. + operationId: post-sdwan-v2.0-api-wannetworks + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANNetworkScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANNetwork' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_INPUT + - code: EXTRA_PROVIDER_ASNUM + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create WAN Network (v2.0) + tags: + - Network Constructs + /sdwan/v2.0/api/wannetworks/query: + post: + description: Query the DB for WAN networks that match query parameters. + operationId: post-sdwan-v2.0-api-wannetworks-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANNetworkQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANNetworkQuery' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SITE_WAN_NETWORK_EXISTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for WAN Networks (v2.0) + tags: + - Network Constructs + /sdwan/v2.0/api/wannetworks/{wan_network_id}: + delete: + description: Delete an existing WAN network. + operationId: delete-sdwan-v2.0-api-wannetworks-wan_network_id + parameters: + - description: The ID of the WAN network. + in: path + name: wan_network_id + required: true + schema: + description: Wan Network Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANNetwork' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SITE_WAN_NETWORK_EXISTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete WAN Network (v2.0) + tags: + - Network Constructs + get: + description: List a WAN network. + operationId: get-sdwan-v2.0-api-wannetworks-wan_network_id + parameters: + - description: The ID of the WAN network. + in: path + name: wan_network_id + required: true + schema: + description: Wan Network Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANNetwork' description: Successful Operation summary: Get WAN Network (v2.0) tags: @@ -2843,7 +3178,178 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/IPSECProfile' + $ref: '#/components/schemas/IPSECProfile' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_VALUE + - code: IPSECCONFIG_INVALID_ENCODED_AUTH_SECRET + - code: IPSECCONFIG_IKEGROUP_REQUIRED + - code: IPSECCONFIG_INVALID_DPD_DELAY + - code: IPSECCONFIG_ESPGROUP_REQUIRED + - code: IPSECCONFIG_AUTHENTICATION_REQUIRED + - code: IPSECCONFIG_INVALID_DPD_TIMEOUT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create IPSEC Profile (v2.1) + tags: + - Network Constructs + /sdwan/v2.1/api/ipsecprofiles/query: + post: + description: Query the DB for limit number of tenant level IPsec profiles that + match the query parameters. + operationId: post-sdwan-v2.1-api-ipsecprofiles-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IPSECProfileQueryFilter' + description: Query Details for IPSECProfile + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/IPSECProfileQueryFilter' + 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 IPSEC Profiles (v2.1) + tags: + - Network Constructs + /sdwan/v2.1/api/ipsecprofiles/{profile_id}: + delete: + description: Delete an IPsec Profile. + operationId: delete-sdwan-v2.1-api-ipsecprofiles-profile_id + parameters: + - description: The ID of the IPsec profile. + in: path + name: profile_id + required: true + schema: + description: Profile Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPSECProfile' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_VALUE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete IPSEC Profile (v2.1) + tags: + - Network Constructs + get: + description: List a specific IPsec Profile. + operationId: get-sdwan-v2.1-api-ipsecprofiles-profile_id + parameters: + - description: The ID of the IPsec profile. + in: path + name: profile_id + required: true + schema: + description: Profile Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPSECProfile' + description: Successful Operation + summary: Get IPSEC Profile (v2.1) + tags: + - Network Constructs + put: + description: Update an IPsec Profile. + operationId: put-sdwan-v2.1-api-ipsecprofiles-profile_id + parameters: + - description: The ID of the IPsec profile. + in: path + name: profile_id + required: true + schema: + description: Profile Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IPSECProfileScreen' + description: Details of the IPSEC profile to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPSECProfile' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_VALUE + - code: IPSECCONFIG_INVALID_ENCODED_AUTH_SECRET + - code: IPSECCONFIG_IKEGROUP_REQUIRED + - code: IPSECCONFIG_INVALID_DPD_DELAY + - code: IPSECCONFIG_ESPGROUP_REQUIRED + - code: IPSECCONFIG_AUTHENTICATION_REQUIRED + - code: IPSECCONFIG_INVALID_DPD_TIMEOUT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update IPSEC Profile (v2.1) + tags: + - Network Constructs + /sdwan/v2.1/api/waninterfacelabels: + get: + description: List all the WAN interface labels for a tenant. + operationId: get-sdwan-v2.1-api-waninterfacelabels + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceLabelV2N1' + type: array + type: object description: Successful Operation '400': content: @@ -2851,30 +3357,22 @@ paths: example: value: _error: - - code: INVALID_JSON_VALUE - - code: IPSECCONFIG_INVALID_ENCODED_AUTH_SECRET - - code: IPSECCONFIG_IKEGROUP_REQUIRED - - code: IPSECCONFIG_INVALID_DPD_DELAY - - code: IPSECCONFIG_ESPGROUP_REQUIRED - - code: IPSECCONFIG_AUTHENTICATION_REQUIRED - - code: IPSECCONFIG_INVALID_DPD_TIMEOUT + - code: WAN_INTERFACE_LABEL_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create IPSEC Profile (v2.1) + summary: Get WAN Interface Labels (v2.1) tags: - Network Constructs - /sdwan/v2.1/api/ipsecprofiles/query: + /sdwan/v2.1/api/waninterfacelabels/query: post: - description: Query the DB for limit number of tenant level IPsec profiles that - match the query parameters. - operationId: post-sdwan-v2.1-api-ipsecprofiles-query + description: Query the DB for WAN interface labels that match query parameters. + operationId: post-sdwan-v2.1-api-waninterfacelabels-query requestBody: content: application/json: schema: - $ref: '#/components/schemas/IPSECProfileQueryFilter' - description: Query Details for IPSECProfile + $ref: '#/components/schemas/WANInterfaceLabelQuery' responses: '200': content: @@ -2885,7 +3383,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/IPSECProfileQueryFilter' + $ref: '#/components/schemas/WANInterfaceLabelQuery' type: array type: object description: Successful Operation @@ -2895,31 +3393,31 @@ paths: example: value: _error: - - code: BAD_QUERY_REQUEST + - code: WAN_INTERFACE_LABEL_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for IPSEC Profiles (v2.1) + summary: Query DB for WAN Interface Labels (v2.1) tags: - Network Constructs - /sdwan/v2.1/api/ipsecprofiles/{profile_id}: - delete: - description: Delete an IPsec Profile. - operationId: delete-sdwan-v2.1-api-ipsecprofiles-profile_id + /sdwan/v2.1/api/waninterfacelabels/{wantinterface_label_id}: + get: + description: List a specific WAN interface label. + operationId: get-sdwan-v2.1-api-waninterfacelabels-wantinterface_label_id parameters: - - description: The ID of the IPsec profile. + - description: The ID of the WAN interface label. in: path - name: profile_id + name: wantinterface_label_id required: true schema: - description: Profile Id + description: Wantinterface Label Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/IPSECProfile' + $ref: '#/components/schemas/WANInterfaceLabelV2N1' description: Successful Operation '400': content: @@ -2927,57 +3425,35 @@ paths: example: value: _error: - - code: INVALID_JSON_VALUE + - code: WAN_INTERFACE_LABEL_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete IPSEC Profile (v2.1) - tags: - - Network Constructs - get: - description: List a specific IPsec Profile. - operationId: get-sdwan-v2.1-api-ipsecprofiles-profile_id - parameters: - - description: The ID of the IPsec profile. - in: path - name: profile_id - required: true - schema: - description: Profile Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/IPSECProfile' - description: Successful Operation - summary: Get IPSEC Profile (v2.1) + summary: Get WAN Interface Label (v2.1) tags: - Network Constructs put: - description: Update an IPsec Profile. - operationId: put-sdwan-v2.1-api-ipsecprofiles-profile_id + description: Update a specific WAN interface label. + operationId: put-sdwan-v2.1-api-waninterfacelabels-wantinterface_label_id parameters: - - description: The ID of the IPsec profile. + - description: The ID of the WAN interface label. in: path - name: profile_id + name: wantinterface_label_id required: true schema: - description: Profile Id + description: Wantinterface Label Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IPSECProfileScreen' - description: Details of the IPSEC profile to be created + $ref: '#/components/schemas/WANInterfaceLabelScreenV2N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/IPSECProfile' + $ref: '#/components/schemas/WANInterfaceLabelV2N1' description: Successful Operation '400': content: @@ -2985,17 +3461,14 @@ paths: example: value: _error: - - code: INVALID_JSON_VALUE - - code: IPSECCONFIG_INVALID_ENCODED_AUTH_SECRET - - code: IPSECCONFIG_IKEGROUP_REQUIRED - - code: IPSECCONFIG_INVALID_DPD_DELAY - - code: IPSECCONFIG_ESPGROUP_REQUIRED - - code: IPSECCONFIG_AUTHENTICATION_REQUIRED - - code: IPSECCONFIG_INVALID_DPD_TIMEOUT + - code: WAN_INTERFACE_LABEL_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: WAN_INTERFACE_LABEL_MISMATCH schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update IPSEC Profile (v2.1) + summary: Update WAN Interface Label (v2.1) tags: - Network Constructs /sdwan/v2.1/api/wannetworks: @@ -3177,6 +3650,147 @@ paths: summary: Update WAN Network (v2.1) tags: - Network Constructs + /sdwan/v2.2/api/waninterfacelabels: + get: + description: List all the WAN interface labels for a tenant. + operationId: get-sdwan-v2.2-api-waninterfacelabels + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceLabelV2N2' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get WAN Interface Labels (v2.2) + tags: + - Network Constructs + /sdwan/v2.2/api/waninterfacelabels/query: + post: + description: Query the DB for WAN interface labels that match query parameters. + operationId: post-sdwan-v2.2-api-waninterfacelabels-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceLabelQuery' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceLabelQuery' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for WAN Interface Labels (v2.2) + tags: + - Network Constructs + /sdwan/v2.2/api/waninterfacelabels/{wantinterface_label_id}: + get: + description: List a specific WAN interface label. + operationId: get-sdwan-v2.2-api-waninterfacelabels-wantinterface_label_id + parameters: + - description: The ID of the WAN interface label. + in: path + name: wantinterface_label_id + required: true + schema: + description: Wantinterface Label Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceLabelV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get WAN Interface Label (v2.2) + tags: + - Network Constructs + put: + description: Update a specific WAN interface label. + operationId: put-sdwan-v2.2-api-waninterfacelabels-wantinterface_label_id + parameters: + - description: The ID of the WAN interface label. + in: path + name: wantinterface_label_id + required: true + schema: + description: Wantinterface Label Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceLabelScreenV2N2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceLabelV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_LABEL_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT + - code: VPNLINK_CONFIG_REQUIRED + - code: WAN_INTERFACE_LABEL_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update WAN Interface Label (v2.2) + tags: + - Network Constructs /sdwan/v2.3/api/waninterfacelabels: get: description: List all the WAN interface labels for a tenant. @@ -3460,46 +4074,10 @@ paths: summary: Update WAN Interface Label (v2.4) tags: - Network Constructs - /sdwan/v3.2/api/lannetworks/query: - post: - description: Query the DB for site LAN networks that match query parameters. - operationId: post-sdwan-v3.2-api-lannetworks-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/LANNetworkQuery' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/LANNetworkQueryFilterResponse' - 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 Site LAN Networks (v3.2) - tags: - - Network Constructs - /sdwan/v3.2/api/sites/{site_id}/lannetworks: + /sdwan/v3.0/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.0-api-sites-site_id-lannetworks parameters: - description: The ID of the site. in: path @@ -3514,20 +4092,20 @@ paths: application/json: schema: allOf: - - $ref: '#/components/schemas/BulkResponse' + - $ref: '#/components/schemas/ListQueryResponse' - properties: items: items: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3' type: array type: object description: Successful Operation - summary: Get LAN Networks (v3.2) + summary: Get LAN Networks (v3.0) tags: - Network Constructs post: description: Create a new LAN network. - operationId: post-sdwan-v3.2-api-sites-site_id-lannetworks + operationId: post-sdwan-v3.0-api-sites-site_id-lannetworks parameters: - description: The ID of the site. in: path @@ -3540,14 +4118,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkScreenV3N2' + $ref: '#/components/schemas/LANNetworkScreenV3' description: Details of the network to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3' description: Successful Operation '400': content: @@ -3567,20 +4145,16 @@ 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.2) + summary: Create LAN Network (v3.0) tags: - Network Constructs - /sdwan/v3.2/api/sites/{site_id}/lannetworks/query: + /sdwan/v3.0/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.0-api-sites-site_id-lannetworks-query parameters: - description: The ID of the site. in: path @@ -3604,17 +4178,17 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LANNetworkQueryFilterV3N2' + $ref: '#/components/schemas/LANNetworkV3' type: array type: object description: Successful Operation - summary: Query LAN Networks (v3.2) + summary: Query LAN Networks (v3.0) tags: - Network Constructs - /sdwan/v3.2/api/sites/{site_id}/lannetworks/{lannetwork_id}: + /sdwan/v3.0/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.0-api-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the site. in: path @@ -3635,7 +4209,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3' description: Successful Operation '400': content: @@ -3648,12 +4222,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete LAN Network (v3.2) + summary: Delete LAN Network (v3.0) 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.0-api-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the site. in: path @@ -3674,14 +4248,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3' description: Successful Operation - summary: Get LAN Network (v3.2) + summary: Get LAN Network (v3.0) 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.0-api-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the site. in: path @@ -3701,14 +4275,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkScreenV3N2' + $ref: '#/components/schemas/LANNetworkScreenV3' description: Details of the network to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N2' + $ref: '#/components/schemas/LANNetworkV3' description: Successful Operation '400': content: @@ -3729,20 +4303,16 @@ 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.2) + summary: Update LAN Network (v3.0) tags: - Network Constructs - /sdwan/v3.3/api/lannetworks/query: + /sdwan/v3.1/api/lannetworks/query: post: description: Query the DB for site LAN networks that match query parameters. - operationId: post-sdwan-v3.3-api-lannetworks-query + operationId: post-sdwan-v3.1-api-lannetworks-query requestBody: content: application/json: @@ -3772,13 +4342,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Site LAN Networks (v3.3) + summary: Query DB for Site LAN Networks (v3.1) tags: - Network Constructs - /sdwan/v3.3/api/sites/{site_id}/lannetworks: + /sdwan/v3.1/api/sites/{site_id}/lannetworks: get: description: List all the LAN networks. - operationId: get-sdwan-v3.3-api-sites-site_id-lannetworks + operationId: get-sdwan-v3.1-api-sites-site_id-lannetworks parameters: - description: The ID of the site. in: path @@ -3797,16 +4367,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LANNetworkV3N3' + $ref: '#/components/schemas/LANNetworkV3N1' type: array type: object description: Successful Operation - summary: Get LAN Networks (v3.3) + summary: Get LAN Networks (v3.1) tags: - Network Constructs post: description: Create a new LAN network. - operationId: post-sdwan-v3.3-api-sites-site_id-lannetworks + operationId: post-sdwan-v3.1-api-sites-site_id-lannetworks parameters: - description: The ID of the site. in: path @@ -3819,14 +4389,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkScreenV3N3' + $ref: '#/components/schemas/LANNetworkScreenV3N1' description: Details of the network to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N3' + $ref: '#/components/schemas/LANNetworkV3N1' description: Successful Operation '400': content: @@ -3846,20 +4416,16 @@ 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.3) + summary: Create LAN Network (v3.1) tags: - Network Constructs - /sdwan/v3.3/api/sites/{site_id}/lannetworks/query: + /sdwan/v3.1/api/sites/{site_id}/lannetworks/query: post: description: Query LAN networks that match query parameters. - operationId: post-sdwan-v3.3-api-sites-site_id-lannetworks-query + operationId: post-sdwan-v3.1-api-sites-site_id-lannetworks-query parameters: - description: The ID of the site. in: path @@ -3883,17 +4449,17 @@ paths: - properties: items: items: - $ref: '#/components/schemas/LANNetworkQueryFilterV3N3' + $ref: '#/components/schemas/LANNetworkQueryFilterV3N1' type: array type: object description: Successful Operation - summary: Query LAN Networks (v3.3) + summary: Query LAN Networks (v3.1) tags: - Network Constructs - /sdwan/v3.3/api/sites/{site_id}/lannetworks/{lannetwork_id}: + /sdwan/v3.1/api/sites/{site_id}/lannetworks/{lannetwork_id}: delete: description: Delete an existing LAN network. - operationId: delete-sdwan-v3.3-api-sites-site_id-lannetworks-lannetwork_id + operationId: delete-sdwan-v3.1-api-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the site. in: path @@ -3914,7 +4480,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N3' + $ref: '#/components/schemas/LANNetworkV3N1' description: Successful Operation '400': content: @@ -3927,12 +4493,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete LAN Network (v3.3) + summary: Delete LAN Network (v3.1) tags: - Network Constructs get: description: List a LAN network. - operationId: get-sdwan-v3.3-api-sites-site_id-lannetworks-lannetwork_id + operationId: get-sdwan-v3.1-api-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the site. in: path @@ -3953,14 +4519,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N3' + $ref: '#/components/schemas/LANNetworkV3N1' description: Successful Operation - summary: Get LAN Network (v3.3) + summary: Get LAN Network (v3.1) tags: - Network Constructs put: description: Update an existing LAN network. - operationId: put-sdwan-v3.3-api-sites-site_id-lannetworks-lannetwork_id + operationId: put-sdwan-v3.1-api-sites-site_id-lannetworks-lannetwork_id parameters: - description: The ID of the site. in: path @@ -3980,14 +4546,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LANNetworkScreenV3N3' + $ref: '#/components/schemas/LANNetworkScreenV3N1' description: Details of the network to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LANNetworkV3N3' + $ref: '#/components/schemas/LANNetworkV3N1' description: Successful Operation '400': content: @@ -4008,14 +4574,10 @@ 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.3) + summary: Update LAN Network (v3.1) tags: - Network Constructs servers: diff --git a/openapi-specs/sdwan/unified/PathPolicy.yaml b/openapi-specs/sdwan/unified/PathPolicy.yaml index 87a439462..03166dc58 100644 --- a/openapi-specs/sdwan/unified/PathPolicy.yaml +++ b/openapi-specs/sdwan/unified/PathPolicy.yaml @@ -2,21 +2,9 @@ components: schemas: Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -30,28 +18,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 BasePolicyRule: properties: description: @@ -390,50 +356,6 @@ components: type: array required: - name - NetworkPolicyGlobalPrefixV2N1: - properties: - description: - description: 'The description of the network policy global prefix. Max size - = 256. - - ' - id: - description: 'The ID of the network policy global prefix. - - ' - type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the network policy global prefix. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'Lists the IPv6 addresses of the network policy global prefix. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - name: - description: 'The name of the network policy global prefix. - - ' - type: string - tags: - description: 'A information field that can be added to identify the network - policy global prefix. Maximum 10 unique tags of length 1024 each are allowed. - - ' - items: - description: Tags - type: string - type: array - required: - - name NetworkPolicyLocalPrefix: properties: description: @@ -532,80 +454,77 @@ components: required: - paths_allowed - name - NetworkPolicyRuleQueryFilterV2N1: + NetworkPolicyRuleQuery: properties: - app_def_ids: - description: 'The app definition IDs that have applied network policy rules. - The number of applications for a policy rule is limited to 256. + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of network policy rules that match the + query parameters. ' - items: - description: App Def Ids - type: string - type: array - description: - description: 'The description of the network policy rule. Max size = 256. + dest_page: + description: 'The destination page. ' - destination_prefixes_id: - description: 'The destination prefix ID. + format: int32 + type: integer + getDeleted: + description: 'The number of network policy rules deleted for a time frame. ' - type: string - enabled: - description: "The network policy rule based on rules that are enabled. \ - \ \n" type: boolean - id: - description: 'The network policy rule ID. + group_by: + description: 'Group the network policy rules for the query. ' + items: + description: Group By + type: string + type: array + id: + description: "Lists the network policy rules by ID. \n" type: string - name: - description: 'The name of the network policy rule. Max size = 128. + last_query_ts: + description: 'Return the ID of a specified query in the current session. ' - type: string - network_context_id: - description: "The network context applied to the network policy rule. Network\ - \ context segments network traffic for the purpose of applying different\ - \ network policy rules for the same application. \n" - type: string - order_number: - description: "The network policy rule order number. The default order number\ - \ for a policy rule is 1024. \n" + format: int64 type: integer - paths_allowed: - $ref: '#/components/schemas/PathsAllowedV2N1' - description: 'The paths allowed for the application. - - ' - policyset_id: - description: "The policy set ID. \n" - type: string - service_context: - $ref: '#/components/schemas/ServiceContext' - description: 'Information on the service context. + limit: + description: 'The query limit. ' - source_prefixes_id: - description: 'The ID of the source prefixes. + format: int32 + type: integer + next_query: + description: 'The limit. ' - 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. + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. ' items: - description: Tags + description: Retrieved Fields type: string type: array - required: - - paths_allowed - - name - NetworkPolicyRuleQueryFilterV2N2: + 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 + NetworkPolicyRuleQueryFilter: properties: app_def_ids: description: 'The app definition IDs that have applied network policy rules. @@ -649,7 +568,7 @@ components: \ for a policy rule is 1024. \n" type: integer paths_allowed: - $ref: '#/components/schemas/PathsAllowedV2N1' + $ref: '#/components/schemas/PathsAllowed' description: 'The paths allowed for the application. ' @@ -675,15 +594,10 @@ components: description: Tags type: string type: array - user_or_group: - $ref: '#/components/schemas/UserGroup' - description: 'The details of the user or group. - - ' required: - paths_allowed - name - NetworkPolicyRuleScreenV2N1: + NetworkPolicyRuleQueryFilterV2N1: properties: app_def_ids: description: 'The app definition IDs that have applied network policy rules. @@ -731,6 +645,9 @@ components: description: 'The paths allowed for the application. ' + policyset_id: + description: "The policy set ID. \n" + type: string service_context: $ref: '#/components/schemas/ServiceContext' description: 'Information on the service context. @@ -753,7 +670,7 @@ components: required: - paths_allowed - name - NetworkPolicyRuleScreenV2N2: + NetworkPolicyRuleScreen: properties: app_def_ids: description: 'The app definition IDs that have applied network policy rules. @@ -797,7 +714,7 @@ components: \ for a policy rule is 1024. \n" type: integer paths_allowed: - $ref: '#/components/schemas/PathsAllowedV2N1' + $ref: '#/components/schemas/PathsAllowed' description: 'The paths allowed for the application. ' @@ -820,15 +737,10 @@ components: description: Tags type: string type: array - user_or_group: - $ref: '#/components/schemas/UserGroup' - description: 'The details of the user or group. - - ' required: - paths_allowed - name - NetworkPolicyRuleV2N1: + NetworkPolicyRuleScreenV2N1: properties: app_def_ids: description: 'The app definition IDs that have applied network policy rules. @@ -895,7 +807,10 @@ components: description: Tags type: string type: array - NetworkPolicyRuleV2N2: + required: + - paths_allowed + - name + NetworkPolicyRuleV2N1: properties: app_def_ids: description: 'The app definition IDs that have applied network policy rules. @@ -962,14 +877,6 @@ components: description: Tags type: string type: array - user_or_group: - $ref: '#/components/schemas/UserGroup' - description: 'The details of the user or group. - - ' - required: - - paths_allowed - - name NetworkPolicySet: properties: clone_from: @@ -1408,41 +1315,6 @@ components: description: 'A information field that can be added to identify the site prefix. Maximum 10 unique tags of length 1024 each are allowed. - ' - items: - description: Tags - type: string - type: array - SiteNetworkPrefixAssociationV2N1: - properties: - id: - description: 'The ID of the site prefix. - - ' - type: string - ipv4_prefixes: - description: 'The individual IPv4 prefixes address. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'The individual IPv4 prefixes address. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - prefix_id: - description: "The IP Prefix ID that associates with a site. \n" - type: string - tags: - description: 'A information field that can be added to identify the site - prefix. Maximum 10 unique tags of length 1024 each are allowed. - ' items: description: Tags @@ -1550,64 +1422,6 @@ components: description: Tags type: string type: array - SitePrefixAssociationQueryFilterV2N1: - properties: - id: - description: 'The ID of the site prefix. - - ' - type: string - ipv4_prefixes: - description: 'The individual IP address. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'Lists the IPv6 address. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - prefix_id: - description: "The IP Prefix ID that associates with a site. \n" - type: string - site_id: - description: 'The site ID binding the prefix. - - ' - type: string - tags: - description: 'A information field that can be added to identify the site - prefix. Maximum 10 unique tags of length 1024 each are allowed. - - ' - items: - description: Tags - type: string - type: array - UserGroup: - properties: - user_group_ids: - description: 'The user group IDs. - - ' - items: - description: User Group Ids - type: string - type: array - user_ids: - description: 'The user IDs. - - ' - items: - description: User Ids - type: string - type: array WANPath: properties: label: @@ -2004,9 +1818,46 @@ paths: summary: Update Network Policy Local Prefix (v2.0) tags: - Path Policy - /sdwan/v2.0/api/networkpolicysets: - get: - description: List all the network policy sets of a tenant. + /sdwan/v2.0/api/networkpolicyrules/query: + post: + description: Query all the network policy rules. + operationId: post-sdwan-v2.0-api-networkpolicyrules-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkPolicyRuleQuery' + description: Details to query the Network policy rules. + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/NetworkPolicyRuleQueryFilter' + 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 Network Policy Rules (v2.0) + tags: + - Path Policy + /sdwan/v2.0/api/networkpolicysets: + get: + description: List all the network policy sets of a tenant. operationId: get-sdwan-v2.0-api-networkpolicysets responses: '200': @@ -2191,6 +2042,238 @@ paths: summary: Update Network Policy Set (v2.0) tags: - Path Policy + /sdwan/v2.0/api/networkpolicysets/{policy_set_id}/networkpolicyrules: + get: + description: List all the network policy rules of a tenant. + operationId: get-sdwan-v2.0-api-networkpolicysets-policy_set_id-networkpolicyrules + parameters: + - description: The network policy set ID. + 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/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/NetworkPolicyRule' + type: array + type: object + description: Successful Operation + summary: Get Network Policy Rules (v2.0) + tags: + - Path Policy + post: + description: Create a new network policy rule. + operationId: post-sdwan-v2.0-api-networkpolicysets-policy_set_id-networkpolicyrules + parameters: + - description: The network policy set ID. + in: path + name: policy_set_id + required: true + schema: + description: Policy Set Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkPolicyRule' + description: Details of the network policy to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkPolicyRule' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DUPLICATE_APP_DEF_IDS + - code: APP_DEF_ID_LIST_SIZE_EXCEEDED + - code: INVALID_NETWORK_CONTEXT_ID + - code: INVALID_ORDER_NUMBER_MINIMUM_VAL + - code: INVALID_ORDER_NUMBER_MAXIMUM_VAL + - code: INVALID_SOURCE_PREFIXES_ID + - code: INVALID_DESTINATION_PREFIXES_ID + - code: PATHS_ALLOWED_REQUIRED + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: NETWORKPOLICYSET_NOT_PRESENT + - code: POLICYRULE_CREATION_NOT_ALLOWED + - code: INVALID_POLICYSET_STATE + - code: INVALID_DEFAULT_RULE_FLAG + - code: POLICYRULE_CONFIG_DEFAULT_RULE_NAME + - code: POLICYRULE_CONFIG_INVALID_APPDEF_IDS + - code: POLICYRULE_CONFIG_INVALID_NETWORK_CONTEXT + - code: POLICYRULE_CONFIG_INVALID_SOURCE_PREFIX + - code: POLICYRULE_CONFIG_INVALID_DESTINATION_PREFIX + - code: POLICYRULE_CONFIG_ACTIVE_BACKUP_SERVICELABELS_SAME + - code: POLICYRULE_CONFIG_SERVICELABEL_DOES_NOT_EXIST + - code: POLICYRULE_CONFIG_INVALID_SERVICE_LABEL_ALLOWED_TRANSIT + - code: POLICYRULE_CONFIG_INVALID_SERVICE_LABEL_REQUIRED_TRANSIT + - code: POLICYRULE_CONFIG_INVALID_CGTRANSIT_VPNPATH_MISSING + - code: POLICYRULE_CONFIG_DUPLICATE_PATHS_SPECIFIED + - code: POLICYRULE_CONFIG_ALREADY_EXISTS_FOR_THE_APPS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Network Policy Rule (v2.0) + tags: + - Path Policy + /sdwan/v2.0/api/networkpolicysets/{policy_set_id}/networkpolicyrules/{policy_rule_id}: + delete: + description: Delete a network policy rule of a tenant. + operationId: delete-sdwan-v2.0-api-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id + parameters: + - description: The network policy set ID. + in: path + name: policy_set_id + required: true + schema: + description: Policy Set Id + type: string + - description: ID of the network policy rule. + in: path + name: policy_rule_id + required: true + schema: + description: Policy Rule Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkPolicyRuleQuery' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: POLICY_SET_CLONE_IN_PROGRESS + - code: CANNOT_DELETE_DEFAULT_POLICY_RULE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Network Policy Rule (v2.0) + tags: + - Path Policy + get: + description: List a specific network policy rule of a tenant. + operationId: get-sdwan-v2.0-api-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id + parameters: + - description: The network policy set ID. + in: path + name: policy_set_id + required: true + schema: + description: Policy Set Id + type: string + - description: ID of the network policy rule. + in: path + name: policy_rule_id + required: true + schema: + description: Policy Rule Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkPolicyRule' + description: Successful Operation + summary: Get Network Policy Rule (v2.0) + tags: + - Path Policy + put: + description: Update a network policy rule of a tenant. + operationId: put-sdwan-v2.0-api-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id + parameters: + - description: The network policy set ID. + in: path + name: policy_set_id + required: true + schema: + description: Policy Set Id + type: string + - description: ID of the network policy rule. + in: path + name: policy_rule_id + required: true + schema: + description: Policy Rule Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkPolicyRuleScreen' + description: Details to update the network policy rule. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkPolicyRule' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: DUPLICATE_APP_DEF_IDS + - code: APP_DEF_ID_LIST_SIZE_EXCEEDED + - code: INVALID_NETWORK_CONTEXT_ID + - code: INVALID_ORDER_NUMBER_MINIMUM_VAL + - code: INVALID_ORDER_NUMBER_MAXIMUM_VAL + - code: INVALID_SOURCE_PREFIXES_ID + - code: INVALID_DESTINATION_PREFIXES_ID + - code: PATHS_ALLOWED_REQUIRED + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: NETWORKPOLICYSET_NOT_PRESENT + - code: INVALID_POLICYSET_STATE + - code: INVALID_DEFAULT_RULE_FLAG + - code: INVALID_DEFAULT_RULE_NAME + - code: INVALID_DEFAULT_RULE_APPDEFS_UPDATE + - code: INVALID_DEFAULT_RULE_DESTINATION_PREFIX_UPDATE + - code: INVALID_DEFAULT_RULE_SOURCE_PREFIX_UPDATE + - code: INVALID_DEFAULT_RULE_ENABLED_FLAG_UPDATE + - code: INVALID_DEFAULT_RULE_NETWORK_CONTEXT_UPDATE + - code: POLICY_RULE_UPDATE_INVALID_NETWORK_CONTEXT + - code: POLICYRULE_CONFIG_INVALID_APPDEF_IDS + - code: POLICYRULE_CONFIG_INVALID_NETWORK_CONTEXT + - code: POLICYRULE_CONFIG_INVALID_SOURCE_PREFIX + - code: POLICYRULE_CONFIG_INVALID_DESTINATION_PREFIX + - code: POLICYRULE_CONFIG_ACTIVE_BACKUP_SERVICELABELS_SAME + - code: POLICYRULE_CONFIG_SERVICELABEL_DOES_NOT_EXIST + - code: POLICYRULE_CONFIG_INVALID_SERVICE_LABEL_ALLOWED_TRANSIT + - code: POLICYRULE_CONFIG_INVALID_SERVICE_LABEL_REQUIRED_TRANSIT + - code: POLICYRULE_CONFIG_INVALID_CGTRANSIT_VPNPATH_MISSING + - code: POLICYRULE_CONFIG_DUPLICATE_PATHS_SPECIFIED + - code: POLICYRULE_CONFIG_ALREADY_EXISTS_FOR_THE_APPS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Network Policy Rule (v2.0) + tags: + - Path Policy /sdwan/v2.0/api/networkpolicysets/{policy_set_id}/status: get: description: List a specific network policy set status of tenant. @@ -2621,231 +2704,6 @@ paths: summary: Update Site Network Policy Local Prefix Association (v2.0) tags: - Path Policy - /sdwan/v2.1/api/networkpolicyglobalprefixes: - get: - description: List all the network policy global prefixes. - operationId: get-sdwan-v2.1-api-networkpolicyglobalprefixes - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/NetworkPolicyGlobalPrefixV2N1' - type: array - type: object - description: Successful Operation - summary: Get Network Policy Global Prefixes (v2.1) - tags: - - Path Policy - post: - description: Create a new global prefix. - operationId: post-sdwan-v2.1-api-networkpolicyglobalprefixes - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyGlobalPrefixV2N1' - description: Details of the Network Global prefix to be created - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyGlobalPrefixV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: NAME_REQD - - code: INVALID_PREFIX - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Global Prefix (v2.1) - tags: - - Path Policy - /sdwan/v2.1/api/networkpolicyglobalprefixes/query: - post: - description: Query all the network global prefixes. - operationId: post-sdwan-v2.1-api-networkpolicyglobalprefixes-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GlobalPrefixQuery' - description: Details to query the Network policy Global prefix. - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/GlobalPrefixQueryFilter' - 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 Network Global Prefixes (v2.1) - tags: - - Path Policy - /sdwan/v2.1/api/networkpolicyglobalprefixes/{prefix_id}: - delete: - description: Delete a network policy global prefix. - operationId: delete-sdwan-v2.1-api-networkpolicyglobalprefixes-prefix_id - parameters: - - description: The network global prefix ID. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyGlobalPrefixV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: PREFIX_IS_USED_IN_POLICY - - code: ENTERPRISE_PREFIX_INVALID_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Network Policy Global Prefix (v2.1) - tags: - - Path Policy - get: - description: Get a specific network policy global prefix. - operationId: get-sdwan-v2.1-api-networkpolicyglobalprefixes-prefix_id - parameters: - - description: The network global prefix ID. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyGlobalPrefixV2N1' - description: Successful Operation - summary: Get Network Policy Global Prefix (v2.1) - tags: - - Path Policy - put: - description: Update a network policy global prefix. - operationId: put-sdwan-v2.1-api-networkpolicyglobalprefixes-prefix_id - parameters: - - description: The network global prefix ID. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyGlobalPrefixV2N1' - description: Details to update the Network policy Global prefix. - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyGlobalPrefixV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: NAME_REQD - - code: INVALID_PREFIX - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: ENTERPRISE_PREFIX_INVALID_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Network Policy Global Prefix (v2.1) - tags: - - Path Policy - /sdwan/v2.1/api/networkpolicylocalprefixes/query: - post: - description: Query site network prefix association. - operationId: post-sdwan-v2.1-api-networkpolicylocalprefixes-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SitePrefixAssociationQuery' - description: Query details for site network prefix association - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SitePrefixAssociationQueryFilterV2N1' - 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 Site Network Prefix Association (v2.1) - tags: - - Path Policy /sdwan/v2.1/api/networkpolicyrules/query: post: description: Query all the network policy rules. @@ -2855,7 +2713,7 @@ paths: application/json: schema: $ref: '#/components/schemas/NetworkPolicyRuleQueryFilterV2N1' - description: Details to query the Network policy rules. + description: Details to update the Network Policy local prefix. responses: '200': content: @@ -3110,472 +2968,6 @@ paths: summary: Update Network Policy Rule (v2.1) tags: - Path Policy - /sdwan/v2.1/api/sites/{site_id}/networkpolicylocalprefixes: - get: - description: List all the site network policy prefix associations. - operationId: get-sdwan-v2.1-api-sites-site_id-networkpolicylocalprefixes - parameters: - - description: The site ID. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SiteNetworkPrefixAssociationV2N1' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Site Network Policy Prefix Associations (v2.1) - tags: - - Path Policy - post: - description: Create the site network policy prefix associations. - operationId: post-sdwan-v2.1-api-sites-site_id-networkpolicylocalprefixes - 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/SiteNetworkPrefixAssociationV2N1' - description: Details of the site Network Policy local prefix to be associated - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SiteNetworkPrefixAssociationV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: LOCAL_PREFIX_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Site Network Policy Prefix Associations (v2.1) - tags: - - Path Policy - /sdwan/v2.1/api/sites/{site_id}/networkpolicylocalprefixes/{prefix_id}: - delete: - description: Delete an existing site network policy prefix association. - operationId: delete-sdwan-v2.1-api-sites-site_id-networkpolicylocalprefixes-prefix_id - parameters: - - description: The site ID. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The network policy local prefix ID. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SiteNetworkPrefixAssociation' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Site Network Policy Prefix Associations (v2.1) - tags: - - Path Policy - get: - description: List all the site network policy prefix association. - operationId: get-sdwan-v2.1-api-sites-site_id-networkpolicylocalprefixes-prefix_id - parameters: - - description: The site ID. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The network policy local prefix ID. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SiteNetworkPrefixAssociationV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Site Network Policy Prefix Association (v2.1) - tags: - - Path Policy - put: - description: Update an existing site network policy prefix association. - operationId: put-sdwan-v2.1-api-sites-site_id-networkpolicylocalprefixes-prefix_id - parameters: - - description: The site ID. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The network policy local prefix ID. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SiteNetworkPrefixAssociationV2N1' - description: Details of the site Network policy local prefix to be updated - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SiteNetworkPrefixAssociationV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: LOCAL_PREFIX_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Site Network Policy Prefix Association (v2.1) - tags: - - Path Policy - /sdwan/v2.2/api/networkpolicyrules/query: - post: - description: Query all the network policy rules. - operationId: post-sdwan-v2.2-api-networkpolicyrules-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyRuleQueryFilterV2N2' - description: Details to query the Network policy rules. - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/NetworkPolicyRuleQueryFilterV2N2' - 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 Network Policy Rules (v2.2) - tags: - - Path Policy - /sdwan/v2.2/api/networkpolicysets/{policy_set_id}/networkpolicyrules: - get: - description: List all the network policy rules of a tenant. - operationId: get-sdwan-v2.2-api-networkpolicysets-policy_set_id-networkpolicyrules - parameters: - - description: The network policy set ID. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - responses: - '200': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/NetworkPolicyRuleV2N2' - type: array - description: Successful Operation - summary: Get Network Policy Rules (v2.2) - tags: - - Path Policy - post: - description: Create a new network policy rule. - operationId: post-sdwan-v2.2-api-networkpolicysets-policy_set_id-networkpolicyrules - parameters: - - description: The network policy set ID. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyRuleScreenV2N2' - description: Details of the network policy to be created - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyRuleV2N2' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: DUPLICATE_APP_DEF_IDS - - code: APP_DEF_ID_LIST_SIZE_EXCEEDED - - code: INVALID_NETWORK_CONTEXT_ID - - code: INVALID_ORDER_NUMBER_MINIMUM_VAL - - code: INVALID_ORDER_NUMBER_MAXIMUM_VAL - - code: INVALID_SOURCE_PREFIXES_ID - - code: INVALID_DESTINATION_PREFIXES_ID - - code: PATHS_ALLOWED_REQUIRED - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: NETWORKPOLICYSET_NOT_PRESENT - - code: POLICYRULE_CREATION_NOT_ALLOWED - - code: INVALID_POLICYSET_STATE - - code: INVALID_DEFAULT_RULE_FLAG - - code: POLICYRULE_CONFIG_DEFAULT_RULE_NAME - - code: POLICYRULE_CONFIG_INVALID_APPDEF_IDS - - code: POLICYRULE_CONFIG_INVALID_NETWORK_CONTEXT - - code: POLICYRULE_CONFIG_INVALID_SOURCE_PREFIX - - code: POLICYRULE_CONFIG_INVALID_DESTINATION_PREFIX - - code: POLICYRULE_CONFIG_ACTIVE_BACKUP_SERVICELABELS_SAME - - code: POLICYRULE_CONFIG_SERVICELABEL_DOES_NOT_EXIST - - code: POLICYRULE_CONFIG_INVALID_SERVICE_LABEL_ALLOWED_TRANSIT - - code: POLICYRULE_CONFIG_INVALID_SERVICE_LABEL_REQUIRED_TRANSIT - - code: POLICYRULE_CONFIG_INVALID_CGTRANSIT_VPNPATH_MISSING - - code: POLICYRULE_CONFIG_DUPLICATE_PATHS_SPECIFIED - - code: POLICYRULE_CONFIG_ALREADY_EXISTS_FOR_THE_APPS - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Network Policy Rule (v2.2) - tags: - - Path Policy - /sdwan/v2.2/api/networkpolicysets/{policy_set_id}/networkpolicyrules/{policy_rule_id}: - delete: - description: Delete a network policy rule of a tenant. - operationId: delete-sdwan-v2.2-api-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id - parameters: - - description: The network policy set ID. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: ID of the network policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyRuleV2N2' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: POLICY_SET_CLONE_IN_PROGRESS - - code: CANNOT_DELETE_DEFAULT_POLICY_RULE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Network Policy Rule (v2.2) - tags: - - Path Policy - get: - description: List a specific network policy rule of a tenant. - operationId: get-sdwan-v2.2-api-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id - parameters: - - description: The network policy set ID. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: ID of the network policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyRuleV2N2' - description: Successful Operation - summary: Get Network Policy Rule (v2.2) - tags: - - Path Policy - put: - description: Update a network policy rule of a tenant. - operationId: put-sdwan-v2.2-api-networkpolicysets-policy_set_id-networkpolicyrules-policy_rule_id - parameters: - - description: The network policy set ID. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: ID of the network policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyRuleScreenV2N2' - description: Details to update the Network Policy policy rule. - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkPolicyRuleV2N2' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: DUPLICATE_APP_DEF_IDS - - code: APP_DEF_ID_LIST_SIZE_EXCEEDED - - code: INVALID_NETWORK_CONTEXT_ID - - code: INVALID_ORDER_NUMBER_MINIMUM_VAL - - code: INVALID_ORDER_NUMBER_MAXIMUM_VAL - - code: INVALID_SOURCE_PREFIXES_ID - - code: INVALID_DESTINATION_PREFIXES_ID - - code: PATHS_ALLOWED_REQUIRED - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: NETWORKPOLICYSET_NOT_PRESENT - - code: INVALID_POLICYSET_STATE - - code: INVALID_DEFAULT_RULE_FLAG - - code: INVALID_DEFAULT_RULE_NAME - - code: INVALID_DEFAULT_RULE_APPDEFS_UPDATE - - code: INVALID_DEFAULT_RULE_DESTINATION_PREFIX_UPDATE - - code: INVALID_DEFAULT_RULE_SOURCE_PREFIX_UPDATE - - code: INVALID_DEFAULT_RULE_ENABLED_FLAG_UPDATE - - code: INVALID_DEFAULT_RULE_NETWORK_CONTEXT_UPDATE - - code: POLICY_RULE_UPDATE_INVALID_NETWORK_CONTEXT - - code: POLICYRULE_CONFIG_INVALID_APPDEF_IDS - - code: POLICYRULE_CONFIG_INVALID_NETWORK_CONTEXT - - code: POLICYRULE_CONFIG_INVALID_SOURCE_PREFIX - - code: POLICYRULE_CONFIG_INVALID_DESTINATION_PREFIX - - code: POLICYRULE_CONFIG_ACTIVE_BACKUP_SERVICELABELS_SAME - - code: POLICYRULE_CONFIG_SERVICELABEL_DOES_NOT_EXIST - - code: POLICYRULE_CONFIG_INVALID_SERVICE_LABEL_ALLOWED_TRANSIT - - code: POLICYRULE_CONFIG_INVALID_SERVICE_LABEL_REQUIRED_TRANSIT - - code: POLICYRULE_CONFIG_INVALID_CGTRANSIT_VPNPATH_MISSING - - code: POLICYRULE_CONFIG_DUPLICATE_PATHS_SPECIFIED - - code: POLICYRULE_CONFIG_ALREADY_EXISTS_FOR_THE_APPS - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Network Policy Rule (v2.2) - tags: - - Path Policy servers: - url: https://api.sase.paloaltonetworks.com tags: diff --git a/openapi-specs/sdwan/unified/PathPolicyOriginal.yaml b/openapi-specs/sdwan/unified/PathPolicyOriginal.yaml index 06f287518..075fb992e 100644 --- a/openapi-specs/sdwan/unified/PathPolicyOriginal.yaml +++ b/openapi-specs/sdwan/unified/PathPolicyOriginal.yaml @@ -2,21 +2,9 @@ components: schemas: Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -30,28 +18,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 BandwidthAllocationScheme: properties: bandwidth_range: diff --git a/openapi-specs/sdwan/unified/PrismaAccessConfigs.yaml b/openapi-specs/sdwan/unified/PrismaAccessConfigs.yaml index 3a27e1dfb..ebf81de5e 100644 --- a/openapi-specs/sdwan/unified/PrismaAccessConfigs.yaml +++ b/openapi-specs/sdwan/unified/PrismaAccessConfigs.yaml @@ -104,12 +104,6 @@ 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. @@ -118,12 +112,6 @@ 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. diff --git a/openapi-specs/sdwan/unified/QOSPolicy.yaml b/openapi-specs/sdwan/unified/QOSPolicy.yaml index 3815cf350..ccc0c5aa5 100644 --- a/openapi-specs/sdwan/unified/QOSPolicy.yaml +++ b/openapi-specs/sdwan/unified/QOSPolicy.yaml @@ -2,21 +2,9 @@ components: schemas: Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -30,28 +18,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 BandwidthAllocationSchemeV2: properties: bandwidth_range: @@ -289,48 +255,6 @@ components: type: array required: - name - GlobalPrefixQueryFilterV2N1: - properties: - description: - description: 'The description of the priority policy global prefix. - - ' - id: - description: 'The ID of the priority policy global prefix. - - ' - type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the priority policy global prefix. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'Lists the IPv6 addresses of the priority policy global prefix. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - name: - description: 'The name of the priority policy global prefix. - - ' - 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. \n" - items: - description: Tags - type: string - type: array - required: - - name ListQueryResponse: properties: count: @@ -492,49 +416,6 @@ components: type: array required: - name - PriorityPolicyGlobalPrefixV2N1: - properties: - description: - description: 'The description of the priority policy global prefix. - - ' - id: - description: 'The ID of the priority policy global prefix. - - ' - type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the priority policy global prefix. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'Lists the IPv6 addresses of the priority policy global prefix. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - name: - description: 'The name of the priority policy global prefix. - - ' - 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. - - ' - items: - description: Tags - type: string - type: array - required: - - name PriorityPolicyLocalPrefix: properties: description: @@ -786,95 +667,76 @@ components: required: - priority_number - name - PriorityPolicyRuleQueryFilterV2N1: + PriorityPolicySet: properties: - app_def_ids: - description: 'The app definition IDs that have applied priority policy rules. - The number of applications for a policy rule is limited to 256. + bandwidth_allocation_schemes: + description: 'The bandwidth allocation schemes configured for a given policy + set. Upto four bandwidth allocation schemes can be configured. ' items: - description: App Def Ids - type: string + $ref: '#/components/schemas/BandwidthAllocationSchemeV2' type: array - description: - description: 'The description of the priority policy rule. Max size = 256. + business_priority_names: + description: 'The business priority names. Max list size = 4. ' - destination_prefixes_id: - description: 'The destination prefix ID. + items: + $ref: '#/components/schemas/BusinessPriorityNameMapper' + type: array + clone_from: + description: 'The existing policy from Stacked Policies for cloning the + policy set. ' type: string - dscp: - $ref: '#/components/schemas/DSCP' - description: 'The DSCP value - When policy rules with marked DSCP bits are - applied to a site, the ION branch device will honor the bits in the first - packet on an unknown application flow, and queue the flow in the specified - priority class. + default_rule_dscp_mappings: + description: "The default rule of the DSCP mappings. \n" + items: + $ref: '#/components/schemas/DefaultRuleDSCPMapping' + type: array + defaultrule_policyset: + description: "The default rule of the policy set. \n" + type: boolean + description: + description: 'The description of the policy set. Max size = 256. ' - enabled: - description: "The priority policy rules based on rules that are enabled.\ - \ \n" - type: boolean id: - description: 'The priority policy rule ID. + description: 'The priority policy set ID. ' type: string name: - description: 'The name of the priority policy rule. Max size = 128. - - ' - type: string - network_context_id: - description: "The network context applied to the priority policy rule.\ - \ Network context segments network traffic for the purpose of applying\ - \ different QoS policy rules for the same application. \n" - type: string - order_number: - description: "The order number. The default order number for a policy rule\ - \ is 1024. \n" - type: integer - policyset_id: - description: "The policy set ID. \n" - type: string - priority_number: - description: 'The priority number. Priority determines the relative priority - of network resources assigned to each application. - - ' - format: int32 - type: integer - source_prefixes_id: - description: 'The source prefix ID. Source prefix filters are often added - as exceptions. + description: 'The name of the policy set. Max size = 128. ' 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. + 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 - user_or_group: - $ref: '#/components/schemas/UserGroup' - description: 'The details of the user or group. + template: + description: 'The template used for cloning the policy rule. The template + option creates a set of rules from a predefined template can be customized + after creation. ' + type: boolean required: - - priority_number + - business_priority_names + - bandwidth_allocation_schemes - name - PriorityPolicyRuleQueryV2N1: + PriorityPolicySetQuery: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of priority policy rules that match the + description: 'The aggregate number of priority policy sets that match the query parameters. ' @@ -885,12 +747,12 @@ components: format: int32 type: integer getDeleted: - description: 'The number of priority policy rules deleted for a time frame. + description: 'The number of priority policy sets deleted for a time frame. ' type: boolean group_by: - description: 'Group the priority policy rules for the query. + description: 'Group the priority policy sets for the query. ' items: @@ -898,7 +760,7 @@ components: type: string type: array id: - description: "Lists the priority policy rules by ID. \n" + description: "Lists the priority policy sets by ID. \n" type: string last_query_ts: description: 'Return the ID of a specified query in the current session. @@ -940,267 +802,54 @@ components: ' format: int64 type: integer - PriorityPolicyRuleV2N1: + PriorityPolicySetQueryFilter: properties: - app_def_ids: - description: 'The app definition IDs that have applied priority policy rules. - The number of applications for a policy rule is limited to 256. + bandwidth_allocation_schemes: + description: 'The bandwidth allocation schemes configured for a given policy + set. Upto four bandwidth allocation schemes can be configured. ' items: - description: App Def Ids - type: string + $ref: '#/components/schemas/BandwidthAllocationSchemeV2' type: array - description: - description: 'The description of the priority policy rule. Max size = 256. + business_priority_names: + description: 'The business priority names. Max list size = 4. ' - destination_prefixes_id: - description: 'The destination prefix ID. + items: + $ref: '#/components/schemas/BusinessPriorityNameMapper' + type: array + clone_from: + description: 'The existing policy from Stacked Policies for cloning the + policy set. ' type: string - dscp: - $ref: '#/components/schemas/DSCP' - description: 'The DSCP value - When policy rules with marked DSCP bits are - applied to a site, the ION branch device will honor the bits in the first - packet on an unknown application flow, and queue the flow in the specified - priority class. + default_rule_dscp_mappings: + description: "The default rule of the DSCP mappings. \n" + items: + $ref: '#/components/schemas/DefaultRuleDSCPMapping' + type: array + defaultrule_policyset: + description: "The default rule of the policy set. \n" + type: boolean + description: + description: 'The description of the policy set. Max size = 256. ' - enabled: - description: "The priority policy rules based on rules that are enabled.\ - \ \n" - type: boolean id: - description: 'The priority policy rule ID. + description: 'The priority policy set ID. ' type: string name: - description: 'The name of the priority policy rule. Max size = 128. + description: 'The name of the policy set. Max size = 128. ' type: string - network_context_id: - description: "The network context applied to the priority policy rule.\ - \ Network context segments network traffic for the purpose of applying\ - \ different QoS policy rules for the same application. \n" - type: string - order_number: - description: "The order number. The default order number for a policy rule\ - \ is 1024. \n" - type: integer - priority_number: - description: 'The priority number. Priority determines the relative priority - of network resources assigned to each application. - - ' - format: int32 - type: integer - source_prefixes_id: - description: 'The source prefix ID. Source prefix filters are often added - as exceptions. - - ' - 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" - items: - description: Tags - type: string - type: array - user_or_group: - $ref: '#/components/schemas/UserGroup' - description: "The details of the user or group. \n" - required: - - priority_number - - name - PriorityPolicySet: - properties: - bandwidth_allocation_schemes: - description: 'The bandwidth allocation schemes configured for a given policy - set. Upto four bandwidth allocation schemes can be configured. - - ' - items: - $ref: '#/components/schemas/BandwidthAllocationSchemeV2' - type: array - business_priority_names: - description: 'The business priority names. Max list size = 4. - - ' - items: - $ref: '#/components/schemas/BusinessPriorityNameMapper' - type: array - clone_from: - description: 'The existing policy from Stacked Policies for cloning the - policy set. - - ' - type: string - default_rule_dscp_mappings: - description: "The default rule of the DSCP mappings. \n" - items: - $ref: '#/components/schemas/DefaultRuleDSCPMapping' - type: array - defaultrule_policyset: - description: "The default rule of the policy set. \n" - type: boolean - description: - description: 'The description of the policy set. Max size = 256. - - ' - id: - description: 'The priority policy set ID. - - ' - type: string - name: - description: 'The name of the policy set. Max size = 128. - - ' - type: string - 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 - template: - description: 'The template used for cloning the policy rule. The template - option creates a set of rules from a predefined template can be customized - after creation. - - ' - type: boolean - required: - - business_priority_names - - bandwidth_allocation_schemes - - name - PriorityPolicySetQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of priority policy sets that match the - query parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number of priority policy sets deleted for a time frame. - - ' - type: boolean - group_by: - description: 'Group the priority policy sets for the query. - - ' - items: - description: Group By - type: string - type: array - id: - description: "Lists the priority policy sets 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 - PriorityPolicySetQueryFilter: - properties: - bandwidth_allocation_schemes: - description: 'The bandwidth allocation schemes configured for a given policy - set. Upto four bandwidth allocation schemes can be configured. - - ' - items: - $ref: '#/components/schemas/BandwidthAllocationSchemeV2' - type: array - business_priority_names: - description: 'The business priority names. Max list size = 4. - - ' - items: - $ref: '#/components/schemas/BusinessPriorityNameMapper' - type: array - clone_from: - description: 'The existing policy from Stacked Policies for cloning the - policy set. - - ' - type: string - default_rule_dscp_mappings: - description: "The default rule of the DSCP mappings. \n" - items: - $ref: '#/components/schemas/DefaultRuleDSCPMapping' - type: array - defaultrule_policyset: - description: "The default rule of the policy set. \n" - type: boolean - description: - description: 'The description of the policy set. Max size = 256. - - ' - id: - description: 'The priority policy set ID. - - ' - type: string - name: - description: 'The name of the policy set. Max size = 128. - - ' - type: string - tags: - description: 'A information field that can be added to identify the policy - set. Maximum 10 unique tags of length 1024 each are allowed. + 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: @@ -1458,59 +1107,6 @@ components: description: Tags type: string type: array - SitePriorityPrefixAssociationV2N1: - properties: - id: - description: 'The ID of the site prefix. - - ' - type: string - ipv4_prefixes: - description: 'The individual IP address. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'Lists the IPv6 address. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - prefix_id: - description: "The IP Prefix ID that associates with a site. \n" - type: string - tags: - description: 'A information field that can be added to identify the site - prefix. Maximum 10 unique tags of length 1024 each are allowed. - - ' - items: - description: Tags - type: string - type: array - UserGroup: - properties: - user_group_ids: - description: 'The user group IDs. - - ' - items: - description: User Group Ids - type: string - type: array - user_ids: - description: 'The user IDs. - - ' - items: - description: User Ids - type: string - type: array info: contact: {} description: List of APIs used to manage the QoS policies. @@ -2784,696 +2380,6 @@ paths: summary: Update Site Priority Policy Local Prefix Association (v2.0) tags: - QOS Policy - /sdwan/v2.1/api/prioritypolicyglobalprefixes: - get: - description: List all the priority policy global prefixes. - operationId: get-sdwan-v2.1-api-prioritypolicyglobalprefixes - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/PriorityPolicyGlobalPrefixV2N1' - type: array - type: object - description: Successful Operation - summary: Get Priority Policy GLobal Prefixes (v2.1) - tags: - - QOS Policy - post: - description: Create a new priority global prefix. - operationId: post-sdwan-v2.1-api-prioritypolicyglobalprefixes - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyGlobalPrefixV2N1' - description: Details of the Priority Global prefix to be created - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyGlobalPrefixV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: NAME_REQD - - code: INVALID_PREFIX - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Priority Global Prefix (v2.1) - tags: - - QOS Policy - /sdwan/v2.1/api/prioritypolicyglobalprefixes/query: - post: - description: Query the priority global prefixes. - operationId: post-sdwan-v2.1-api-prioritypolicyglobalprefixes-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GlobalPrefixQuery' - description: Query Details for Priority Global - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/GlobalPrefixQueryFilterV2N1' - 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 Priority Global Prefixes (v2.1) - tags: - - QOS Policy - /sdwan/v2.1/api/prioritypolicyglobalprefixes/{priority_policy_id}: - delete: - description: Delete a priority policy global prefix. - operationId: delete-sdwan-v2.1-api-prioritypolicyglobalprefixes-priority_policy_id - parameters: - - description: The ID of the priority policy. - in: path - name: priority_policy_id - required: true - schema: - description: Priority Policy Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyGlobalPrefixV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: PREFIX_IS_USED_IN_POLICY - - code: ENTERPRISE_PREFIX_INVALID_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Priority Policy Global Prefix (v2.1) - tags: - - QOS Policy - get: - description: List a specific priority policy global prefix. - operationId: get-sdwan-v2.1-api-prioritypolicyglobalprefixes-priority_policy_id - parameters: - - description: The ID of the priority policy. - in: path - name: priority_policy_id - required: true - schema: - description: Priority Policy Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyGlobalPrefixV2N1' - description: Successful Operation - summary: Get Priority Policy Global Prefix (v2.1) - tags: - - QOS Policy - put: - description: Update a priority policy global prefix. - operationId: put-sdwan-v2.1-api-prioritypolicyglobalprefixes-priority_policy_id - parameters: - - description: The ID of the priority policy. - in: path - name: priority_policy_id - required: true - schema: - description: Priority Policy Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyGlobalPrefixV2N1' - description: Details to update the Priority policy Global prefix. - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyGlobalPrefixV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: NAME_REQD - - code: INVALID_PREFIX - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: ENTERPRISE_PREFIX_INVALID_REQUEST - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Priority Policy Global Prefix (v2.1) - tags: - - QOS Policy - /sdwan/v2.1/api/prioritypolicylocalprefixes/query: - post: - description: Query the site priority prefix association. - operationId: post-sdwan-v2.1-api-prioritypolicylocalprefixes-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SitePrefixAssociationQuery' - description: Query details for site priority prefix association - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SitePrefixAssociationQueryFilter' - 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 Site Priority Prefix Association (v2.1) - tags: - - QOS Policy - /sdwan/v2.1/api/prioritypolicyrules/query: - post: - description: Query the priority policy rules. - operationId: post-sdwan-v2.1-api-prioritypolicyrules-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyRuleQueryV2N1' - description: Query details for Priority Policy rules - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/PriorityPolicyRuleQueryFilterV2N1' - 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 Priority Policy Rules (v2.1) - tags: - - QOS Policy - /sdwan/v2.1/api/prioritypolicysets/{policy_set_id}/prioritypolicyrules: - get: - description: List the priority policy rules of a tenant. - operationId: get-sdwan-v2.1-api-prioritypolicysets-policy_set_id-prioritypolicyrules - parameters: - - description: The ID of the priority 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/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/PriorityPolicyRuleV2N1' - type: array - type: object - description: Successful Operation - summary: Get Priority Policy Rules (v2.1) - tags: - - QOS Policy - post: - description: Create a new priority policy rule. - operationId: post-sdwan-v2.1-api-prioritypolicysets-policy_set_id-prioritypolicyrules - parameters: - - description: The ID of the priority policy set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyRuleV2N1' - description: Details of the priority policy to be created - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyRuleV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: DUPLICATE_APP_DEF_IDS - - code: APP_DEF_ID_LIST_SIZE_EXCEEDED - - code: INVALID_NETWORK_CONTEXT_ID - - code: INVALID_ORDER_NUMBER_MINIMUM_VAL - - code: INVALID_ORDER_NUMBER_MAXIMUM_VAL - - code: INVALID_SOURCE_PREFIXES_ID - - code: INVALID_DESTINATION_PREFIXES_ID - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: PRIORITYPOLICYSET_NOT_PRESENT - - code: POLICYRULE_CREATION_NOT_ALLOWED - - code: INVALID_POLICYSET_STATE - - code: INVALID_DEFAULT_RULE_FLAG - - code: POLICYRULE_CONFIG_DEFAULT_RULE_NAME - - code: POLICYRULE_CONFIG_INVALID_APPDEF_IDS - - code: POLICYRULE_CONFIG_INVALID_NETWORK_CONTEXT - - code: POLICYRULE_CONFIG_INVALID_SOURCE_PREFIX - - code: POLICYRULE_CONFIG_INVALID_DESTINATION_PREFIX - - code: POLICYRULE_CONFIG_ALREADY_EXISTS_FOR_THE_APPS - - code: INVALID_PRIORITY_NUMBER - - code: PRIORITY_NUMBER_MINIMUM_VAL - - code: PRIORITY_NUMBER_MAXIMUM_VAL - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Priority Policy Rule (v2.1) - tags: - - QOS Policy - /sdwan/v2.1/api/prioritypolicysets/{policy_set_id}/prioritypolicyrules/{policy_rule_id}: - delete: - description: Delete a priority policy rule of a tenant. - operationId: delete-sdwan-v2.1-api-prioritypolicysets-policy_set_id-prioritypolicyrules-policy_rule_id - parameters: - - description: The ID of the priority policy set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: The ID of the priority policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyRuleV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: POLICY_SET_CLONE_IN_PROGRESS - - code: CANNOT_DELETE_DEFAULT_POLICY_RULE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Priority Policy Rule (v2.1) - tags: - - QOS Policy - get: - description: Get a specific priority policy rule of a tenant. - operationId: get-sdwan-v2.1-api-prioritypolicysets-policy_set_id-prioritypolicyrules-policy_rule_id - parameters: - - description: The ID of the priority policy set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: The ID of the priority policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyRuleV2N1' - description: Successful Operation - summary: Get Priority Policy Rule (v2.1) - tags: - - QOS Policy - put: - description: Update a priority policy rule of a tenant. - operationId: put-sdwan-v2.1-api-prioritypolicysets-policy_set_id-prioritypolicyrules-policy_rule_id - parameters: - - description: The ID of the priority policy set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: The ID of the priority policy rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyRuleV2N1' - description: Query details for Priority Policy rules - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PriorityPolicyRuleV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: DUPLICATE_APP_DEF_IDS - - code: APP_DEF_ID_LIST_SIZE_EXCEEDED - - code: INVALID_NETWORK_CONTEXT_ID - - code: INVALID_ORDER_NUMBER_MINIMUM_VAL - - code: INVALID_ORDER_NUMBER_MAXIMUM_VAL - - code: INVALID_SOURCE_PREFIXES_ID - - code: INVALID_DESTINATION_PREFIXES_ID - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: PRIORITYPOLICYSET_NOT_PRESENT - - code: INVALID_POLICYSET_STATE - - code: INVALID_DEFAULT_RULE_FLAG - - code: INVALID_DEFAULT_RULE_NAME - - code: INVALID_DEFAULT_RULE_APPDEFS_UPDATE - - code: INVALID_DEFAULT_RULE_DESTINATION_PREFIX_UPDATE - - code: INVALID_DEFAULT_RULE_SOURCE_PREFIX_UPDATE - - code: INVALID_DEFAULT_RULE_ENABLED_FLAG_UPDATE - - code: INVALID_DEFAULT_RULE_NETWORK_CONTEXT_UPDATE - - code: POLICY_RULE_UPDATE_INVALID_NETWORK_CONTEXT - - code: POLICYRULE_CONFIG_INVALID_APPDEF_IDS - - code: POLICYRULE_CONFIG_INVALID_NETWORK_CONTEXT - - code: POLICYRULE_CONFIG_INVALID_SOURCE_PREFIX - - code: POLICYRULE_CONFIG_INVALID_DESTINATION_PREFIX - - code: POLICYRULE_CONFIG_ALREADY_EXISTS_FOR_THE_APPS - - code: INVALID_PRIORITY_NUMBER - - code: PRIORITY_NUMBER_MINIMUM_VAL - - code: PRIORITY_NUMBER_MAXIMUM_VAL - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Priority Policy Rule (v2.1) - tags: - - QOS Policy - /sdwan/v2.1/api/sites/{site_id}/prioritypolicylocalprefixes: - get: - description: List all the site priority policy prefix associations. - operationId: get-sdwan-v2.1-api-sites-site_id-prioritypolicylocalprefixes - parameters: - - description: The 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/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SitePriorityPrefixAssociationV2N1' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Site Priority Policy Prefix Associations (v2.1) - tags: - - QOS Policy - post: - description: Create an association between the site and the priority local prefix. - operationId: post-sdwan-v2.1-api-sites-site_id-prioritypolicylocalprefixes - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SitePriorityPrefixAssociationV2N1' - description: Details of the site Priority Policy local prefix to be associated - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SitePriorityPrefixAssociationV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: NETWRK_POLICY_PREFIX_INVALID - - code: LOCAL_PREFIX_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Association between Site and Priority Local Prefix (v2.1) - tags: - - QOS Policy - /sdwan/v2.1/api/sites/{site_id}/prioritypolicylocalprefixes/{prefix_id}: - delete: - description: Delete an existing site priority policy local prefix association. - operationId: delete-sdwan-v2.1-api-sites-site_id-prioritypolicylocalprefixes-prefix_id - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The priority policy local prefix ID. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SitePriorityPrefixAssociationV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Site Priority Policy Local Prefix Association (v2.1) - tags: - - QOS Policy - get: - description: List a site priority policy local prefix association. - operationId: get-sdwan-v2.1-api-sites-site_id-prioritypolicylocalprefixes-prefix_id - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The priority policy local prefix ID. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SitePriorityPrefixAssociationV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Site Priority Policy Local Prefix Association (v2.1) - tags: - - QOS Policy - put: - description: Update an existing site priority policy local prefix association. - operationId: put-sdwan-v2.1-api-sites-site_id-prioritypolicylocalprefixes-prefix_id - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The priority policy local prefix ID. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SitePriorityPrefixAssociationV2N1' - description: Details of the site Priority policy local prefix to be updated - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SitePriorityPrefixAssociationV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: SITE_NOT_FOUND - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_JSON_COMMON_ATTR_MISMATCH - - code: PRIORITY_POLICY_PREFIX_INVALID - - code: LOCAL_PREFIX_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Site Priority Policy Local Prefix Association (v2.1) - tags: - - QOS Policy servers: - url: https://api.sase.paloaltonetworks.com tags: diff --git a/openapi-specs/sdwan/unified/Routing.yaml b/openapi-specs/sdwan/unified/Routing.yaml index 93fb36271..0608da73c 100644 --- a/openapi-specs/sdwan/unified/Routing.yaml +++ b/openapi-specs/sdwan/unified/Routing.yaml @@ -23,21 +23,9 @@ components: Action: {} Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -51,28 +39,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 BGPConfig: properties: adv_interval: @@ -124,7 +90,7 @@ components: \ default is 120 seconds. \n" format: int32 type: integer - BGPGlobalConfigScreenV2N2: + BGPGlobalConfig: properties: admin_distance: description: "The BGP config admin distance. The device sets the default\ @@ -192,12 +158,6 @@ 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,11 +169,6 @@ components: description: 'The type of prefix advertisement; Default, Unaggregated or Auto-aggregated. - ' - type: string - prefix_adv_type_to_lan: - description: 'The prefix advertises to LAN. - ' type: string prefixes_to_adv_to_wan: @@ -236,7 +191,7 @@ components: ' format: int32 type: integer - BGPGlobalConfigScreenV2N3: + BGPGlobalConfigScreen: properties: admin_distance: description: "The BGP config admin distance. The device sets the default\ @@ -267,14 +222,6 @@ 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. @@ -312,14 +259,6 @@ 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. @@ -331,11 +270,6 @@ components: description: 'The type of prefix advertisement; Default, Unaggregated or Auto-aggregated. - ' - type: string - prefix_adv_type_to_lan: - description: 'The prefix advertises to LAN. - ' type: string prefixes_to_adv_to_wan: @@ -358,7 +292,7 @@ components: ' format: int32 type: integer - BGPGlobalConfigV2N2: + BGPGlobalConfigScreenV2N1: properties: admin_distance: description: "The BGP config admin distance. The device sets the default\ @@ -426,14 +360,6 @@ 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. @@ -448,9 +374,7 @@ components: ' type: string prefix_adv_type_to_lan: - description: 'The prefix advertises to LAN. - - ' + description: Prefix Adv Type To Lan type: string prefixes_to_adv_to_wan: description: 'The prefix advertises to WAN. @@ -472,7 +396,7 @@ components: ' format: int32 type: integer - BGPGlobalConfigV2N3: + BGPGlobalConfigScreenV2N2: properties: admin_distance: description: "The BGP config admin distance. The device sets the default\ @@ -503,14 +427,6 @@ 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. @@ -549,9 +465,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 @@ -594,228 +508,305 @@ components: ' format: int32 type: integer - BGPPeerAdvertisedPrefixes: + BGPGlobalConfigV2N1: properties: - advertised_prefix_count: - description: 'The advertised prefix count for the BGP peer. + admin_distance: + description: "The BGP config admin distance. The device sets the default\ + \ Admin Distance of all learned prefixes to 20. The admin value should\ + \ be in the range 1-255. \n" + format: int32 + type: integer + adv_interval: + description: 'The advertisement interval of the BGP config. The advertisement + interval should be between 0 - 300 seconds and the default is 1 second. ' format: int32 type: integer - advertised_prefixes: - $ref: '#/components/schemas/PrefixSet' - description: 'The advertised prefixes of the BGP peer. + graceful_restart: + description: 'By default, graceful restart is Off. Change the default setting + to On. ' - id: - description: 'The ID of the BGP peer. + type: boolean + hold_time: + description: 'The BGP config hold time. The hold time should be between + 3 - 600 seconds. ' - type: string - BGPPeerAdvertisedPrefixesV2N1: - properties: - advertised_ipv6_prefix_count: - description: Advertised Ipv6 Prefix Count format: int32 type: integer - advertised_prefix_count: - description: Advertised Prefix Count + id: + description: "The BGP configuration ID. \n" + type: string + keepalive_time: + description: 'The keep-alive time of the BGP config. The keep-alive time + should be between 3 - 200 seconds. + + ' 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. + local_as_num: + description: 'The Local AS Number should be between 1 and 4294967295 or + as A.B, where A and B are both numbers between 1 and 4294967295. If the + number entered is an A.B format, the web interface displays the corresponding + 32-bit conversion below the entered value. If the number entered is a + 32-bit format, the web interface displays the corresponding A.B value + below the entered value. The Local AS Number is mandatory. ' - id: - description: "The ID of the prefix filter list. \n" type: string - BGPPeerConfigScreenV2N3: - properties: - bgp_config: - $ref: '#/components/schemas/BGPConfig' - description: 'The details of the BGP config. + maximum_paths: + description: 'The BGP config maximum paths. The max path value should be + between 1 - 255. The default is 1. ' - description: - description: "The description of the BGP peer config. Max size = 1024. \n" - id: - description: 'The ID of the BGP peer config. + format: int32 + type: integer + md5_secret: + description: 'The MD5 Secret should be between 1 and 32 characters. The + default value is 0. ' type: string - name: - description: 'The name of the BGP peer config. Max size = 128. + multi_hop_limit: + description: 'The BGP config multi hop limit. The multi-hop limit should + be between 1 - 255 hops. The default is 1 hop. ' - 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. + format: int32 + type: integer + peer_retry_time: + description: 'The peer retry time should be between 0 - 65535 seconds. The + default is 120 seconds. ' - type: string - remote_as_num: - description: 'The remote AS number. + format: int32 + type: integer + prefix_adv_type: + description: 'The type of prefix advertisement; Default, Unaggregated or + Auto-aggregated. ' type: string - route_map_in_id: - description: 'The ID of the Route Map In to filter incoming routes. - - ' + prefix_adv_type_to_lan: + description: Prefix Adv Type To Lan type: string - route_map_out_id: - description: 'The ID of the Route Map Out to filter outgoing routes. + prefixes_to_adv_to_wan: + description: 'The prefix advertises to WAN. ' - type: string + items: + description: Prefixes To Adv To Wan + type: string + type: array router_id: - description: 'The IP address of the ION device. + description: 'The IP address of the ION device. Max size = 256. ' 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. + stalepath_time: + description: 'The stale path time for the BGP config. The stalepath time + should be between 1 - 3600 seconds. The default is 120 seconds. ' - 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. + format: int32 + type: integer + BGPGlobalConfigV2N2: + properties: + admin_distance: + description: "The BGP config admin distance. The device sets the default\ + \ Admin Distance of all learned prefixes to 20. The admin value should\ + \ be in the range 1-255. \n" + format: int32 + type: integer + adv_interval: + description: 'The advertisement interval of the BGP config. The advertisement + interval should be between 0 - 300 seconds and the default is 1 second. ' - items: - description: Tags - type: string - type: array - update_source: - 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 - - name - BGPPeerConfigScreenV2N4: - properties: - allow_v4_prefixes: - description: 'Allow v4 prefixes. + format: int32 + type: integer + graceful_restart: + description: 'By default, graceful restart is Off. Change the default setting + to On. ' 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. + hold_time: + description: 'The BGP config hold time. The hold time should be between + 3 - 600 seconds. ' - description: - description: "The description of the BGP peer config. Max size = 1024. \n" + format: int32 + type: integer id: - description: 'The ID of the BGP peer config. + description: "The BGP configuration ID. \n" + type: string + keepalive_time: + description: 'The keep-alive time of the BGP config. The keep-alive time + should be between 3 - 200 seconds. ' - type: string - name: - description: 'The name of the BGP peer config. Max size = 128. + format: int32 + type: integer + local_as_num: + description: 'The Local AS Number should be between 1 and 4294967295 or + as A.B, where A and B are both numbers between 1 and 4294967295. If the + number entered is an A.B format, the web interface displays the corresponding + 32-bit conversion below the entered value. If the number entered is a + 32-bit format, the web interface displays the corresponding A.B value + below the entered value. The Local AS Number is mandatory. ' type: string - peer_ip: - description: 'The peer IP address. + maximum_paths: + description: 'The BGP config maximum paths. The max path value should be + between 1 - 255. The default is 1. ' - 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 - only for data center ION devices. + format: int32 + type: integer + md5_secret: + description: 'The MD5 Secret should be between 1 and 32 characters. The + default value is 0. ' type: string - remote_as_num: - description: 'The remote AS number. + multi_hop_limit: + description: 'The BGP config multi hop limit. The multi-hop limit should + be between 1 - 255 hops. The default is 1 hop. ' - type: string - route_map_in_id: - description: 'The ID of the Route Map In to filter incoming routes. + format: int32 + type: integer + peer_auth_type: + description: 'The authentication type of the BGP peer. ' + enum: + - md5 + - none type: string - route_map_out_id: - description: 'The ID of the Route Map Out to filter outgoing routes. + peer_retry_time: + description: 'The peer retry time should be between 0 - 65535 seconds. The + default is 120 seconds. + + ' + format: int32 + type: integer + prefix_adv_type: + description: 'The type of prefix advertisement; Default, Unaggregated or + Auto-aggregated. ' 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. + prefix_adv_type_to_lan: + description: 'The prefix advertises to LAN. ' - 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. + prefixes_to_adv_to_wan: + description: 'The prefix advertises to WAN. ' items: - description: Tags + description: Prefixes To Adv To Wan type: string type: array - update_source: - description: 'The Update Source IP address. + router_id: + description: 'The IP address of the ION device. Max size = 256. + + ' + type: string + stalepath_time: + description: 'The stale path time for the BGP config. The stalepath time + should be between 1 - 3600 seconds. The default is 120 seconds. + + ' + format: int32 + type: integer + BGPPeerAdvertisedPrefixes: + properties: + advertised_prefix_count: + description: 'The advertised prefix count for the BGP peer. + + ' + format: int32 + type: integer + advertised_prefixes: + $ref: '#/components/schemas/PrefixSet' + description: 'The advertised prefixes of the BGP peer. + + ' + id: + description: 'The ID of the BGP peer. + + ' + type: string + BGPPeerConfig: + properties: + 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 + name: + description: "The name of the BGP peer config. Max size = 128. \n" + 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 + remote_as_num: + description: 'The remote AS number. ' type: string - update_source_v6: - description: 'The Update Source IPv6 address. + route_map_in_id: + description: 'The ID of the Route Map In to filter incoming routes. ' type: string - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. + route_map_out_id: + description: 'The ID of the Route Map Out to filter outgoing routes. ' type: string + tags: + description: "A information field that can be added to identify the BGP\ + \ peer. Maximum 10 unique tags of length 1024 each are allowed. \n" + items: + description: Tags + type: string + type: array + update_source: + description: "The Update Source IP address. \n" + type: string required: - - allow_v6_prefixes - - allow_v4_prefixes - remote_as_num + - peer_ip - name - BGPPeerConfigV2N3: + BGPPeerConfigEtag: + properties: + id: + description: 'The BGP peer config etag ID. + + ' + type: string + BGPPeerConfigV2N1: properties: bgp_config: $ref: '#/components/schemas/BGPConfig' @@ -858,11 +849,11 @@ components: ' type: string - router_id: - description: "The IP address of the ION device. \n" - type: string scope: - description: '' + 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 @@ -882,26 +873,14 @@ 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 - BGPPeerConfigV2N4: + BGPPeerConfigV2N2: 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. @@ -920,12 +899,7 @@ components: ' type: string peer_ip: - description: 'The peer IP address. - - ' - type: string - peer_ip_v6: - description: "The peer IPv6 address. \n" + description: "The peer IP address. \n" type: string peer_type: description: 'The peer type = Classic. The Peer Type option is available @@ -948,15 +922,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. - - ' + 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 @@ -976,22 +946,11 @@ 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 BGPPeerDiscoveredPrefixes: properties: @@ -1011,90 +970,13 @@ components: id: description: 'The ID of the BGP peer. - ' - type: string - BGPPeerDiscoveredPrefixesV2N1: - 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. - - ' - type: string - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. - - ' - type: string - BGPPeerDiscoveredPrefixesV2N2: - 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 - 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 - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. - ' type: string BGPPeerOperations: properties: - action: - description: 'The BGP peer actions. - - ' - enum: - - HARD_RESET - - SOFT_RESET - - REVERT_AUTOGENERATED - - REFRESH_STATUS - type: string - id: - description: 'The ID of the BGP peer. - - ' + value: + description: Value type: string - required: - - action BGPPeerQuery: properties: aggregate: @@ -1164,7 +1046,7 @@ components: ' format: int64 type: integer - BGPPeerQueryFilterV2N2: + BGPPeerQueryFilter: properties: bgp_config: $ref: '#/components/schemas/BGPConfig' @@ -1207,18 +1089,6 @@ components: ' 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. @@ -1235,8 +1105,9 @@ components: type: string required: - remote_as_num + - peer_ip - name - BGPPeerQueryFilterV2N3: + BGPPeerQueryFilterV2N1: properties: bgp_config: $ref: '#/components/schemas/BGPConfig' @@ -1279,18 +1150,11 @@ 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. - - ' + 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 @@ -1310,26 +1174,14 @@ 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 - BGPPeerQueryFilterV2N4: + BGPPeerQueryFilterV2N2: 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. @@ -1348,12 +1200,7 @@ components: ' type: string peer_ip: - description: 'The peer IP address. - - ' - type: string - peer_ip_v6: - description: "The peer IPv6 address. \n" + description: "The peer IP address. \n" type: string peer_type: description: 'The peer type = Classic. The Peer Type option is available @@ -1374,19 +1221,13 @@ components: route_map_out_id: description: 'The ID of the Route Map Out to filter outgoing routes. - ' - type: string - router_id: - description: 'The ID of the Route. - ' 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. - - ' + 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 @@ -1406,22 +1247,11 @@ 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: properties: @@ -1456,66 +1286,8 @@ components: ' format: int32 type: integer - BGPPeerReachablePrefixesV2N1: - properties: - filtered_ipv4_prefixes: - description: 'The filtered 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. - - ' - format: int32 - type: integer - filtered_ipv6_prefixes: - description: 'The filtered IPv6 prefixes for the BGP peer. - - ' - items: - $ref: '#/components/schemas/PrefixInfo' - type: array - 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: - $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: - $ref: '#/components/schemas/PrefixInfo' - type: array - reachable_ipv6_prefixes_count: - description: 'The reachable IPv6 prefixes count for the BGP peer. - - ' - format: int32 - type: integer - BGPPeerStatusV2N1: + BGPPeerStatus: properties: - direction: - description: "The direction for the BGP peer. \n" - type: string downtime: description: 'The downtime configured for the BGP peer. @@ -1536,12 +1308,10 @@ components: ' type: string - BGPPeerStatusV2N2: + BGPPeerStatusV2N1: properties: direction: - description: 'The direction for the BGP peer. - - ' + description: "The direction for the BGP peer. \n" type: string downtime: description: 'The downtime configured for the BGP peer. @@ -1563,14 +1333,6 @@ components: ' type: string - v4_capability_negotiated: - description: "The v4 negotiated capability. \n" - type: boolean - v6_capability_negotiated: - description: 'The v6 negotiated capability. - - ' - type: boolean Direction: {} EnterprisePrefixSetN: properties: @@ -1587,29 +1349,6 @@ components: description: Ipv4 Enterprise Prefixes type: string type: array - EnterprisePrefixSetNV2N1: - 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: Ipv4 Enterprise Prefixes - type: string - type: array - ipv6_enterprise_prefixes: - description: 'The IPv6 configuration of the tenant enterprise prefix. - - ' - items: - description: Ipv6 Enterprise Prefixes - type: string - type: array Error: properties: _error: @@ -1711,11 +1450,6 @@ components: description: "The vlan ID. \n" format: int32 type: integer - vrf_context_id: - description: 'The VRF (Virtual Routing and Forwarding) ID. - - ' - type: string LocalPrefixSet: properties: local_networks: @@ -1817,96 +1551,65 @@ components: ' type: string - PrefixQueryFilterV3: + PrefixSet: 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. + ipv4_set: + description: 'The set of The IPv4 addresses. ' - 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. + items: + description: Ipv4 Set + type: string + type: array + ipv6_set: + description: 'The set of The IPv6 addresses. ' - type: string - required: - - site_id - PrefixQueryFilterV3N1: + items: + description: Ipv6 Set + type: string + type: array + RoutingAccessList: 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. + as_path_regex_list: + description: 'The AS Path Regex expression list. ' - type: string - resource_id: - description: 'The resource 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. ' + id: + description: "The ID of the access list. \n" type: string - resource_type: - description: 'The resource type. + name: + description: 'The name of the access list. Max size = 128. ' - 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. + 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: string + items: + description: Tags + type: string + type: array required: - - site_id - PrefixQueryV3: + - name + RoutingAccessListQuery: properties: aggregate: $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of prefix sets that match the query parameters. + description: 'The aggregate number of access/prefix lists that match the + query parameters. ' dest_page: @@ -1915,15 +1618,13 @@ components: ' format: int32 type: integer - ge: - type: integer getDeleted: - description: 'The number prefix sets deleted for a time frame. + description: 'The number of access/prefix lists deleted for a time frame. ' type: boolean group_by: - description: 'Group the prefix sets for the query. + description: 'Group the access/prefix lists for the query. ' items: @@ -1931,10 +1632,7 @@ components: type: string type: array id: - description: "List the prefix sets by ID. \n" - type: string - ipv4_prefix: - description: Ipv4 Prefix + 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. @@ -1942,8 +1640,6 @@ components: ' format: int64 type: integer - le: - type: integer limit: description: 'The query limit. @@ -1956,9 +1652,6 @@ components: ' type: object query_params: - description: 'Query using query parameters. - - ' type: object retrieved_fields: description: 'Retrieve information from a field. @@ -1974,278 +1667,67 @@ 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. - - ' + description: "The total number of query parameters. \n" format: int64 type: integer - PrefixQueryV3N1: + RoutingAccessListQueryFilter: properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of prefix sets that match the query parameters. + as_path_regex_list: + description: 'The AS Path Regex expression list. ' - dest_page: - description: 'The destination page. + 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 - ge: - type: integer - getDeleted: - description: 'The number prefix sets deleted for a time frame. + id: + description: "The peer IP address. \n" + type: string + name: + description: 'The name of the access list. Max size = 128. ' - type: boolean - group_by: - description: 'Group the prefix sets for the query. + 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: Group By + description: Tags type: string type: array + required: + - name + RoutingAccessListQueryFilterV2N1: + 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: "List the prefix sets by ID. \n" - type: string - ipv4_prefix: - description: Ipv4 Prefix - type: string - ipv6_prefix: - description: Ipv6 Prefix + description: "The ID of the access list. \n" 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 - 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: - 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 access list. Max size = 1024. - - ' - id: - description: "The ID of the access list. \n" - type: string - name: - description: 'The name of the access list. Max size = 128. - - ' - 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: Tags - type: string - 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. - - ' - format: int32 - type: integer - 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 - 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. \n" - format: int64 - type: integer - RoutingAccessListQueryFilter: - 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 peer IP address. \n" - type: string - name: - description: 'The name of the access list. Max size = 128. - - ' - 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: Tags - type: string - type: array - required: - - name - RoutingAccessListQueryFilterV2N1: - 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 access list. \n" - type: string - name: - description: 'The name of the access list. Max size = 128. + name: + description: 'The name of the access list. Max size = 128. ' type: string @@ -2558,46 +2040,6 @@ components: ' format: int32 type: integer - ipv6_prefix: - description: 'The IPv6 address prefix. - - ' - 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 - 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: '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" @@ -2619,6 +2061,8 @@ components: ' type: string + required: + - prefix RoutingPrefixList: properties: auto_generated: @@ -2693,43 +2137,6 @@ components: type: array required: - name - RoutingPrefixListQueryFilterV2N1: - 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 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 RoutingPrefixListScreen: properties: auto_generated: @@ -2767,72 +2174,34 @@ components: type: array required: - 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 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 - RoutingPrefixListV2N1: + RoutingRouteMap: properties: auto_generated: - description: 'The value true or false for auto-generated prefix list for - an element. + description: 'The value true or false for auto-generated route map for an + element. ' type: boolean description: - description: 'The description of the prefix filter list. Max size = 1024. + description: 'The description of the route map. Max size = 1024. ' id: - description: "The ID of the prefix filter list. \n" + description: "The ID of the route map. \n" type: string name: - description: 'The name of the prefix filter list. Max size = 128. + description: 'The name of the route map. Max size = 128. ' type: string - prefix_filter_list: - description: "The details of the prefix filter list used to filter routes.\ - \ \n" + route_map_entries: + description: "The details of the route map entries. \n" items: - $ref: '#/components/schemas/RoutingPrefixFilterV2N1' + $ref: '#/components/schemas/RoutingRouteMapEntry' 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 route + map. Maximum 10 unique tags of length 1024 each are allowed. ' items: @@ -2841,7 +2210,7 @@ components: type: array required: - name - RoutingRouteMapEntryV2N1: + RoutingRouteMapEntry: properties: continue_entry: description: 'To continue to use the rule that the route matches. @@ -2869,7 +2238,7 @@ components: description: 'The details of the route map set. ' - RoutingRouteMapEntryV2N2: + RoutingRouteMapEntryV2N1: properties: continue_entry: description: 'To continue to use the rule that the route matches. @@ -2966,7 +2335,7 @@ components: ' format: int64 type: integer - RoutingRouteMapQueryFilterV2N1: + RoutingRouteMapQueryFilter: properties: auto_generated: description: 'The value true or false for auto-generated route map for an @@ -2989,7 +2358,7 @@ components: route_map_entries: description: "The details of the route map entries. \n" items: - $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' + $ref: '#/components/schemas/RoutingRouteMapEntry' type: array tags: description: 'A information field that can be added to identify the route @@ -3002,7 +2371,7 @@ components: type: array required: - name - RoutingRouteMapQueryFilterV2N2: + RoutingRouteMapQueryFilterV2N1: properties: auto_generated: description: 'The value true or false for auto-generated route map for an @@ -3025,7 +2394,7 @@ components: route_map_entries: description: "The details of the route map entries. \n" items: - $ref: '#/components/schemas/RoutingRouteMapEntryV2N2' + $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' type: array tags: description: 'A information field that can be added to identify the route @@ -3038,7 +2407,7 @@ components: type: array required: - name - RoutingRouteMapScreenV2N1: + RoutingRouteMapScreen: properties: auto_generated: description: 'The value true or false for auto-generated route map for an @@ -3061,52 +2430,20 @@ components: route_map_entries: description: "The details of the route map entries. \n" items: - $ref: '#/components/schemas/RoutingRouteMapEntryV2N1' + $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. \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. + 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 - 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: + RoutingRouteMapScreenV2N1: properties: auto_generated: description: 'The value true or false for auto-generated route map for an @@ -3140,7 +2477,7 @@ components: type: array required: - name - RoutingRouteMapV2N2: + RoutingRouteMapV2N1: properties: auto_generated: description: 'The value true or false for auto-generated route map for an @@ -3163,11 +2500,11 @@ components: route_map_entries: description: "The details of the route map entries. \n" items: - $ref: '#/components/schemas/RoutingRouteMapEntryV2N2' + $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" + \ map. Maximum 10 unique tags of length 1024 each are allowed. \n" items: description: Tags type: string @@ -3239,6 +2576,58 @@ components: ' type: boolean + StaticRoute: + properties: + 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 + network_context_id: + description: 'The ID of the network context. + + ' + type: string + 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: + - scope + - nexthops + - destination_prefix StaticRouteStatus: properties: id: @@ -3269,11 +2658,8 @@ components: items: $ref: '#/components/schemas/StateNextHop' type: array - StaticRouteV2N2: + StaticRouteV2N1: properties: - address_family: - description: "The static route address family. \n" - type: string description: description: 'The description of the static route. Max size = 256. @@ -3290,9 +2676,8 @@ components: ' type: string name: - description: 'The name of the static route. - - ' + 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. @@ -3300,9 +2685,7 @@ components: ' type: string nexthop_reachability_probe: - description: 'The Next Hop Reachability Probe is enabled. - - ' + description: Nexthop Reachability Probe type: boolean nexthops: description: 'The details of the next hops configured on the static route. @@ -3322,20 +2705,17 @@ components: - 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. - - ' + 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: - - address_family - scope - nexthops - destination_prefix - StaticRouteV2N3: + StaticRouteV2N2: properties: address_family: description: "The static route address family. \n" @@ -3396,418 +2776,11 @@ components: 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, @@ -3818,295 +2791,41 @@ 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 + description: List the prefix set of a tenant enterprise. + operationId: get-sdwan-v2.0-api-enterpriseprefixset responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/RoutingAccessList' - type: array - type: object + $ref: '#/components/schemas/EnterprisePrefixSetN' 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 Tenant Enterprise Prefix Set (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 + 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/RoutingAccessListScreen' - description: Details of the as-path access list to be created + $ref: '#/components/schemas/EnterprisePrefixSetN' + description: Enterprise prefix Set responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessList' + $ref: '#/components/schemas/EnterprisePrefixSetN' 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) + summary: Update Tenant Enterprise Prefix Set (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 + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/bgpconfigs: + get: + description: List all the BGP configurations from NB. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-bgpconfigs parameters: - description: The ID of the site. in: path @@ -4122,89 +2841,27 @@ paths: 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' + - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/RoutingAccessListQueryFilter' + $ref: '#/components/schemas/BGPGlobalConfig' 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) + summary: Get BGP Configs from NB (v2.0) tags: - Routing + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/bgpconfigs/{bgp_config_id}: get: - description: Get a specific access list. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_aspathaccesslists-config_id + description: List a specific BGP configuration from NB. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id parameters: - description: The ID of the site. in: path @@ -4220,26 +2877,26 @@ paths: schema: description: Element Id type: string - - description: The BGP peer config ID. + - description: The ID of the BGP config. in: path - name: config_id + name: bgp_config_id required: true schema: - description: Config Id + description: Bgp Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessList' + $ref: '#/components/schemas/BGPGlobalConfig' description: Successful Operation - summary: Get Access List (v2.0) + summary: Get BGP Config from NB (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 + description: Updates the BGP configuration from NB. + operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id parameters: - description: The ID of the site. in: path @@ -4255,25 +2912,25 @@ paths: schema: description: Element Id type: string - - description: The ID of the access list. + - description: The ID of the BGP config. in: path - name: config_id + name: bgp_config_id required: true schema: - description: Config Id + description: Bgp Config 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/BGPGlobalConfigScreen' + description: Details of the bgp config to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessList' + $ref: '#/components/schemas/BGPGlobalConfig' description: Successful Operation '400': content: @@ -4281,19 +2938,30 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_ACCESS_LIST + - 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: BGP_CONFIG_INVALID_MAXIMUM_PATHS + - code: BGP_CONFIG_INVALID_ADMIN_DISTANCE + - code: BGP_CONFIG_INVALID_PREFIX + - code: BGP_CONFIG_INVALID_STALEPATH_TIME schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Access List (v2.0) + summary: Update BGP Config from NB (v2.0) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_ipcommunitylists: + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/bgppeers: 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: List all the BGP peer configurations from NB. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-bgppeers parameters: - description: The ID of the site. in: path @@ -4319,78 +2987,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingCommunityList' + $ref: '#/components/schemas/BGPPeerConfig' 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) + summary: Get BGP Peer Configs from NB (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 + description: Create a BGP peer configuration. + operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-bgppeers parameters: - description: The ID of the site. in: path @@ -4410,21 +3016,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingCommunityListQuery' - description: Query details for Routing Community + $ref: '#/components/schemas/BGPGlobalConfigScreen' + description: Details of the BGP peer config to be created 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/BGPPeerConfig' description: Successful Operation '400': content: @@ -4432,18 +3031,33 @@ paths: example: value: _error: - - code: BAD_REQUEST + - 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 schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Community Lists (v2.0) + summary: Create BGP Peer Config (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 + /sdwan/v2.0/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.0-api-sites-site_id-elements-element_id-bgppeers-query parameters: - description: The ID of the site. in: path @@ -4459,19 +3073,25 @@ paths: 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/BGPPeerQuery' + description: Query Details for BGP Peers responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingCommunityList' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerQueryFilter' + type: array + type: object description: Successful Operation '400': content: @@ -4479,17 +3099,17 @@ paths: example: value: _error: - - code: COMMUNITY_LIST_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_COMMUNITY_LIST + - code: BAD_QUERY_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Community List (v2.0) + summary: Query DB for BGP Peers (v2.0) tags: - Routing + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/bgppeers/status: 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 peer statuses from NB. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-bgppeers-status parameters: - description: The ID of the site. in: path @@ -4505,26 +3125,27 @@ 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: - $ref: '#/components/schemas/RoutingCommunityList' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerStatus' + type: array + type: object description: Successful Operation - summary: Get Community List (v2.0) + summary: Get BGP Peer Status from NB (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.0/api/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_id}: + delete: + description: Delete the BGP peer configuration. + operationId: delete-sdwan-v2.0-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: The ID of the site. in: path @@ -4540,25 +3161,19 @@ paths: schema: description: Element Id type: string - - description: The ID of the IP community list. + - description: The ID of the BGP peer. in: path - name: config_id + name: bgp_peer_id required: true schema: - description: Config Id + description: Bgp Peer 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/BGPPeerConfig' description: Successful Operation '400': content: @@ -4566,22 +3181,16 @@ paths: 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 + - code: PEER_CONFIG_INVALID_PEER_IP schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Community List (v2.0) + summary: Delete BGP Peer Config (v2.0) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_prefixlists: 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: Get the BGP peer configuration. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: The ID of the site. in: path @@ -4597,36 +3206,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/RoutingPrefixList' - type: array - type: object + $ref: '#/components/schemas/BGPPeerConfig' 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) + summary: Get BGP Peer Config (v2.0) tags: - Routing - post: - description: Create an IP Prefix List. - operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_prefixlists + put: + description: Update the BGP peer configuration. + operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: The ID of the site. in: path @@ -4642,18 +3241,25 @@ 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/RoutingPrefixListScreen' - description: Details of the prefix list to be created + $ref: '#/components/schemas/BGPGlobalConfigScreen' + description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixList' + $ref: '#/components/schemas/BGPPeerConfig' description: Successful Operation '400': content: @@ -4661,21 +3267,32 @@ paths: example: value: _error: - - code: ELEMENT_NOT_FOUND - - code: ELEMENT_NOT_ASSIGNED_TO_SITE - - code: NOT_SUPPORTED_BY_ELEMENT + - 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 schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create IP Prefix List (v2.0) + summary: Update BGP Peer Config (v2.0) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_prefixlists/query: + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_id}/operations: 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: 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 @@ -4691,25 +3308,25 @@ 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/RoutingAccessListQuery' - description: Query details for access lists + $ref: '#/components/schemas/BGPPeerOperations' + description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/RoutingPrefixListQueryFilter' - type: array - type: object + $ref: '#/components/schemas/BGPPeerOperations' description: Successful Operation '400': content: @@ -4717,18 +3334,17 @@ paths: example: value: _error: - - code: BAD_REQUEST - - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: BGP_PEER_CONFIG_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Prefix Lists (v2.0) + summary: Reset BGP Peer Config (v2.0) tags: - Routing - /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 + /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 @@ -4744,7 +3360,7 @@ paths: schema: description: Element Id type: string - - description: The ID of the prefix list. + - description: The ID of the BGP peer config. in: path name: config_id required: true @@ -4756,25 +3372,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixList' + $ref: '#/components/schemas/BGPPeerAdvertisedPrefixes' description: Successful Operation - '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) + 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: Get a specific prefix list. - operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_prefixlists-config_id + 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 @@ -4790,7 +3396,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 @@ -4802,14 +3408,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixList' + $ref: '#/components/schemas/BGPPeerDiscoveredPrefixes' description: Successful Operation - summary: Get Prefix List (v2.0) + summary: Get BGP Discovered Prefixes (v2.0) tags: - Routing - put: - description: Update a prefix list. - operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_prefixlists-config_id + /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 @@ -4825,45 +3432,27 @@ paths: schema: description: Element Id type: string - - description: The ID of the prefix 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/RoutingPrefixListScreen' - description: Details of the prefix list to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixList' + $ref: '#/components/schemas/BGPPeerReachablePrefixes' description: Successful Operation - '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) + summary: Get BGP Reachable Prefix (v2.0) tags: - Routing - /sdwan/v2.0/api/sites/{site_id}/localprefixset: - get: - description: List the site local prefix set. - operationId: get-sdwan-v2.0-api-sites-site_id-localprefixset + /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 parameters: - description: The ID of the site. in: path @@ -4872,20 +3461,49 @@ 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 + - 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/LocalPrefixSet' + $ref: '#/components/schemas/BGPPeerStatus' description: Successful Operation - summary: Get Site Local Prefix Set (v2.0) + summary: Get BGP Peer Status from NB (v2.0) tags: - Routing - /sdwan/v2.0/api/vrfcontextprofiles: + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists: get: - description: List all the VRF context profiles. - operationId: get-sdwan-v2.0-api-vrfcontextprofiles + 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: @@ -4896,164 +3514,109 @@ paths: - properties: items: items: - $ref: '#/components/schemas/VRFContextProfile' + $ref: '#/components/schemas/RoutingAccessList' 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-sdwan-v2.0-api-vrfcontextprofiles - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VRFContextProfileScreen' - description: VRF Context Profile Request - responses: - '200': - content: - application/json: - schema: - $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 + - code: ELEMENT_NOT_ASSIGNED_TO_SITE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create VRF Context Profile (v2.0) + summary: Get Access List for Element (v2.0) tags: - Routing - /sdwan/v2.0/api/vrfcontextprofiles/query: post: - description: Query VRF context profiles. - operationId: post-sdwan-v2.0-api-vrfcontextprofiles-query - 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: 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 + 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 VRF context profile. + - description: The ID of the site. in: path - name: vrf_context_profile_id + name: site_id required: true schema: - description: Vrf Context Profile Id + description: Site Id type: string - 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: Delete VRF Context Profile (v2.0) - tags: - - Routing - get: - description: Get a VRF context profile. - operationId: get-sdwan-v2.0-api-vrfcontextprofiles-vrf_context_profile_id - parameters: - - description: The ID of the VRF context profile. + - description: The ID of the element. in: path - name: vrf_context_profile_id + name: element_id required: true schema: - description: Vrf Context Profile Id + 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/VRFContextProfile' + $ref: '#/components/schemas/RoutingAccessList' description: Successful Operation - '404': + '400': content: application/json: example: value: _error: - - code: VRF_CONTEXT_PROFILE_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: NOT FOUND - summary: Get VRF Context Profile (v2.0) + description: Bad Request + summary: Create AS-Path Access List (v2.0) tags: - Routing - put: - description: Update a VRF context profile. - operationId: put-sdwan-v2.0-api-vrfcontextprofiles-vrf_context_profile_id + /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 VRF context profile. + - 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: vrf_context_profile_id + name: element_id required: true schema: - description: Vrf Context Profile Id + description: Element Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/VRFContextProfileScreen' - description: Details of vrf context profile to be updated + $ref: '#/components/schemas/RoutingAccessListQuery' + description: Query details for access lists responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VRFContextProfile' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingAccessListQueryFilter' + type: array + type: object description: Successful Operation '400': content: @@ -5061,58 +3624,45 @@ paths: 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 + - code: BAD_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update VRF Context Profile (v2.0) - tags: - - Routing - /sdwan/v2.0/api/vrfcontexts: - get: - description: Get a VRF segments. - operationId: get-sdwan-v2.0-api-vrfcontexts - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/VRFContext' - type: array - type: object - description: Successful Operation - summary: Get VRF Segments (v2.0) + summary: Query DB for Access Lists (v2.0) tags: - Routing - 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 + /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/VRFContext' + $ref: '#/components/schemas/RoutingAccessList' description: Successful Operation '400': content: @@ -5120,129 +3670,178 @@ paths: 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 + - code: ACCESS_LIST_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_ACCESS_LIST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create VRF Segment (v2.0) + summary: Delete Access List (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 + 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: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/VRFContextQueryFilter' - type: array - type: object + $ref: '#/components/schemas/RoutingAccessList' description: Successful Operation - summary: Query VRF Contexts (v2.0) + summary: Get Access List (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 + 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 VRF context. + - 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: vrf_context_id + name: config_id required: true schema: - description: Vrf Context Id + 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/VRFContext' + $ref: '#/components/schemas/RoutingAccessList' description: Successful Operation - '404': + '400': content: application/json: example: value: _error: - - code: VRF_CONTEXT_NAME_INVALID + - code: CANNOT_UPDATE_AUTOGENERATED_ACCESS_LIST + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH schema: $ref: '#/components/schemas/Error' - description: NOT FOUND - summary: Delete VRF Segment (v2.0) + 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 a VRF segment. - operationId: get-sdwan-v2.0-api-vrfcontexts-vrf_context_id + 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 VRF context. + - 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: vrf_context_id + name: element_id required: true schema: - description: Vrf Context Id + description: Element Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VRFContext' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingCommunityList' + type: array + type: object description: Successful Operation - '404': + '400': content: application/json: example: value: _error: - - code: INVALID_VRF_CONTEXT_ID + - code: ELEMENT_NOT_ASSIGNED_TO_SITE schema: $ref: '#/components/schemas/Error' - description: Not Found - summary: Get VRF Segment (v2.0) + description: Bad Request + summary: Get Community List for Element (v2.0) tags: - Routing - put: - description: Update a VRF context. - operationId: put-sdwan-v2.0-api-vrfcontexts-vrf_context_id + 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 VRF context. + - description: The ID of the site. in: path - name: vrf_context_id + 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: Vrf Context Id + description: Element Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/VRFContextScreen' - description: Details of vrf segment to be updated + $ref: '#/components/schemas/RoutingAccessListScreen' + description: Details of the community list to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VRFContext' + $ref: '#/components/schemas/RoutingCommunityList' description: Successful Operation '400': content: @@ -5250,52 +3849,24 @@ paths: example: value: _error: - - code: VRF_CONTEXT_CONFIG_DESCRIPTION_INVALID - - code: VRF_CONTEXT_NAME_EXCEEDS_LIMIT - - code: VRF_CONTEXT_NAME_INVALID + - 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: Update VRF Context (v2.0) - tags: - - Routing - /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) + summary: Create IP Community List (v2.0) 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 + /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 @@ -5311,63 +3882,44 @@ 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/ListResponse' + - $ref: '#/components/schemas/ListQueryResponse' - properties: items: items: - $ref: '#/components/schemas/BGPPeerStatusV2N1' + $ref: '#/components/schemas/RoutingCommunityListQueryFilter' type: array type: object description: Successful Operation - summary: Get BGP Peer Status from NB (v2.1) - tags: - - Routing - /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 - 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': + '400': content: application/json: + example: + value: + _error: + - code: BAD_REQUEST + - code: ELEMENT_NOT_ASSIGNED_TO_SITE schema: - $ref: '#/components/schemas/BGPPeerAdvertisedPrefixesV2N1' - description: Successful Operation - summary: Get BGP Peer Advertised Prefixes (v2.0) + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Community Lists (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 + /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 @@ -5383,27 +3935,37 @@ paths: schema: description: Element Id type: string - - description: BGP Peer Config Id + - description: The ID of the IP community list. in: path - name: bgp_peer_config_id + name: config_id required: true schema: - description: Bgp Peer Config Id + description: Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerReachablePrefixesV2N1' + $ref: '#/components/schemas/RoutingCommunityList' description: Successful Operation - summary: Get BGP Reachable Prefix (v2.0) + '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 - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/discoveredprefixes: get: - description: List all the BGP discovered prefix information. - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-bgppeers-config_id-discoveredprefixes + 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 @@ -5419,7 +3981,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 @@ -5431,15 +3993,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BGPPeerDiscoveredPrefixesV2N1' + $ref: '#/components/schemas/RoutingCommunityList' description: Successful Operation - summary: Get BGP Discovered Prefixes (v2.0) + summary: Get Community List (v2.0) tags: - Routing - /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 + put: + 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 @@ -5455,27 +4016,48 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP peer config. + - 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/BGPPeerStatusV2N1' + $ref: '#/components/schemas/RoutingCommunityList' description: Successful Operation - summary: Get BGP Peer Status from NB (v2.1) + '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.1/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists: + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_prefixlists: 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: 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 @@ -5501,12 +4083,9 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingPrefixList' type: array type: object - items: - $ref: '#/components/schemas/RoutingAccessListV2N1' - type: array description: Successful Operation '400': content: @@ -5518,12 +4097,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Access List for Element (v2.1) + summary: Get Prefix List for Element (v2.0) 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 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 @@ -5543,14 +4122,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListScreenV2N1' - description: Details of the as-path access list 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/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingPrefixList' description: Successful Operation '400': content: @@ -5565,14 +4144,14 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create AS-Path Access List (v2.1) + summary: Create IP Prefix List (v2.0) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/query: + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_prefixlists/query: post: - 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 + 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 @@ -5604,7 +4183,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingAccessListQueryFilterV2N1' + $ref: '#/components/schemas/RoutingPrefixListQueryFilter' type: array type: object description: Successful Operation @@ -5619,13 +4198,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Access Lists (v2.1) + summary: Query DB for Prefix Lists (v2.0) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/{config_id}: + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_prefixlists/{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 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 @@ -5641,7 +4220,7 @@ paths: schema: description: Element Id type: string - - description: The ID of the access list. + - description: The ID of the prefix list. in: path name: config_id required: true @@ -5653,25 +4232,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingPrefixList' description: Successful Operation '400': content: application/json: example: value: - _error: - - code: ACCESS_LIST_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_ACCESS_LIST + _error: + - code: PREFIX_LIST_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_PREFIX_LIST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Access List (v2.1) + summary: Delete Prefix List (v2.0) 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 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 @@ -5699,14 +4278,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingPrefixList' description: Successful Operation - summary: Get Access List (v2.1) + summary: Get Prefix List (v2.0) 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 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 @@ -5722,7 +4301,7 @@ paths: schema: description: Element Id type: string - - description: The ID of the access list. + - description: The ID of the prefix list. in: path name: config_id required: true @@ -5733,14 +4312,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' - description: Details of the access list to be updated + $ref: '#/components/schemas/RoutingPrefixListScreen' + description: Details of the prefix list to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingAccessListV2N1' + $ref: '#/components/schemas/RoutingPrefixList' description: Successful Operation '400': content: @@ -5748,28 +4327,28 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_ACCESS_LIST + - 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 Access List (v2.1) + summary: Update Prefix List (v2.0) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_prefixlists: + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_routemaps: get: - description: Get all Prefix List for Element - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_prefixlists + description: List all the route maps for an element. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_routemaps parameters: - - description: Site Id + - description: The ID of the site. in: path name: site_id required: true schema: description: Site Id type: string - - description: Element Id + - description: The ID of the element. in: path name: element_id required: true @@ -5786,7 +4365,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingPrefixListV2N1' + $ref: '#/components/schemas/RoutingRouteMap' type: array type: object description: Successful Operation @@ -5800,21 +4379,21 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get all Prefix List for Element (v2.1) + summary: Get Route Map for Element (v2.0) tags: - Routing post: - description: Create IP Prefix List - operationId: post-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_prefixlists + description: Create a route map. + operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_routemaps parameters: - - description: Site Id + - description: The ID of the site. in: path name: site_id required: true schema: description: Site Id type: string - - description: Element Id + - description: The ID of the element. in: path name: element_id required: true @@ -5825,14 +4404,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixListScreenV2N1' - description: Details of the prefix list to be created + $ref: '#/components/schemas/RoutingRouteMapScreen' + description: Details of route map to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixListV2N1' + $ref: '#/components/schemas/RoutingRouteMap' description: Successful Operation '400': content: @@ -5844,26 +4423,35 @@ paths: - code: ELEMENT_NOT_ASSIGNED_TO_SITE - code: NOT_SUPPORTED_BY_ELEMENT - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: PREFIX_LIST_PREFIX_NOT_SUPPORTED + - 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 schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create IP Prefix List (v2.1) + summary: Create Route Map (v2.0) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_prefixlists/query: + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_routemaps/query: post: - 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 + 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 parameters: - - description: Site Id + - description: The ID of the site. in: path name: site_id required: true schema: description: Site Id type: string - - description: Element Id + - description: The ID of the element. in: path name: element_id required: true @@ -5874,8 +4462,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: @@ -5886,7 +4474,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingPrefixListQueryFilterV2N1' + $ref: '#/components/schemas/RoutingRouteMapQueryFilter' type: array type: object description: Successful Operation @@ -5897,46 +4485,44 @@ paths: value: _error: - code: BAD_REQUEST - - code: ELEMENT_NOT_ASSIGNED_TO_SITE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Queries db for limit number of prefix lists that match query params. - (v2.1) + summary: Query DB for Route Maps (v2.1) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_prefixlists/{routing_prefixlist_id}: + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/routing_routemaps/{config_id}: delete: - description: Delete Prefix List - operationId: delete-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_prefixlists-routing_prefixlist_id + description: Delete a route map. + operationId: delete-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - - description: Site Id + - description: The ID of the site. in: path name: site_id required: true schema: description: Site Id type: string - - description: Element Id + - description: The ID of the element. in: path name: element_id required: true schema: description: Element Id type: string - - description: Prefix List Id + - description: The ID of the route map. in: path - name: routing_prefixlist_id + name: config_id required: true schema: - description: Routing Prefixlist Id + description: Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixListV2N1' + $ref: '#/components/schemas/RoutingRouteMap' description: Successful Operation '400': content: @@ -5944,86 +4530,86 @@ paths: example: value: _error: - - code: PREFIX_LIST_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_PREFIX_LIST + - code: ROUTE_MAP_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_ROUTE_MAP schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Prefix List (v2.1) + summary: Delete Route Map (v2.0) tags: - Routing get: - description: Get Specific Prefix List - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_prefixlists-routing_prefixlist_id + description: Get a specific route map. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - - description: Site Id + - description: The ID of the site. in: path name: site_id required: true schema: description: Site Id type: string - - description: Element Id + - description: The ID of the element. in: path name: element_id required: true schema: description: Element Id type: string - - description: Prefix List Id + - description: The BGP peer config ID. in: path - name: routing_prefixlist_id + name: config_id required: true schema: - description: Routing Prefixlist Id + description: Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixListV2N1' + $ref: '#/components/schemas/RoutingRouteMap' description: Successful Operation - summary: Get Specific Prefix List (v2.1) + summary: Get Route Map (v2.0) tags: - Routing put: - description: Updates Prefix List - operationId: put-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_prefixlists-routing_prefixlist_id + description: Update a route map. + operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-routing_routemaps-config_id parameters: - - description: Site Id + - description: The ID of the site. in: path name: site_id required: true schema: description: Site Id type: string - - description: Element Id + - description: The ID of the element. in: path name: element_id required: true schema: description: Element Id type: string - - description: Prefix List Id + - description: The ID of the route map. in: path - name: routing_prefixlist_id + name: config_id required: true schema: - description: Routing Prefixlist Id + description: Config Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixListScreenV2N1' - description: Details of the prefix list to be updated + $ref: '#/components/schemas/RoutingRouteMapScreen' + description: Details of route map to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingPrefixListV2N1' + $ref: '#/components/schemas/RoutingRouteMap' description: Successful Operation '400': content: @@ -6031,20 +4617,28 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_PREFIX_LIST + - code: CANNOT_UPDATE_AUTOGENERATED_ROUTE_MAP - 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: Updates Prefix List (v2.1) + summary: Update Route Map (v2.0) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_routemaps: + /sdwan/v2.0/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.0-api-sites-site_id-elements-element_id-staticroutes parameters: - description: The ID of the site. in: path @@ -6070,26 +4664,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + $ref: '#/components/schemas/StaticRoute' 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.0) 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.0-api-sites-site_id-elements-element_id-staticroutes parameters: - description: The ID of the site. in: path @@ -6109,14 +4693,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapV2N1' - description: Details of the route map to be created + $ref: '#/components/schemas/StaticRoute' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + $ref: '#/components/schemas/StaticRoute' description: Successful Operation '400': content: @@ -6124,66 +4707,127 @@ 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: ROUTE_MAP_ENTRY_WITH_RESERVED_ORDER + - code: STATICROUTE_CONFIG_INVALID_DEVICE + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP + - code: INTERFACE_NOT_FOUND + - 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.0) 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.0/api/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}: + delete: + description: Delete a static route. + operationId: delete-sdwan-v2.0-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 + - 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/StaticRoute' + description: Successful Operation + summary: Delete Static Route (v2.0) + tags: + - Routing + get: + description: Get a specific static route. + operationId: get-sdwan-v2.0-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/StaticRoute' + description: Successful Operation + summary: Get Static Route (v2.0) + tags: + - Routing + put: + description: Update a static route. + operationId: put-sdwan-v2.0-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/RoutingRouteMapQuery' - description: Query details for route maps + $ref: '#/components/schemas/StaticRoute' 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/StaticRoute' description: Successful Operation '400': content: @@ -6191,18 +4835,46 @@ paths: example: value: _error: - - code: BAD_REQUEST - - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: STATICROUTE_CONFIG_INVALID_DEVICE + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP_DUPLICATE + - code: STATICROUTE_CONFIG_INVALID_NEXTHOP + - code: INTERFACE_NOT_FOUND + - code: INVALID_NETWORK_CONTEXT + - code: PREFIX_EXACT_MATCH_WITH_OTHER_SITE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Route Maps (v2.1) + summary: Update Static Route (v2.0) + tags: + - Routing + /sdwan/v2.0/api/sites/{site_id}/localprefixset: + get: + 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 + name: site_id + required: true + 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 - /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 + /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 parameters: - description: The ID of the site. in: path @@ -6218,37 +4890,27 @@ 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: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPGlobalConfigV2N1' + type: array + type: object description: Successful Operation - '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) + summary: Get BGP Configs from NB (v2.1) tags: - Routing + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/bgpconfigs/{bgp_config_id}: get: - description: Get a specific route map. - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_routemaps-config_id + description: List a specific BGP configuration from NB. + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id parameters: - description: The ID of the site. in: path @@ -6264,26 +4926,26 @@ paths: schema: description: Element Id type: string - - description: The BGP peer config ID. + - description: The ID of the BGP config. in: path - name: config_id + name: bgp_config_id required: true schema: - description: Config Id + description: Bgp Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + $ref: '#/components/schemas/BGPGlobalConfigV2N1' description: Successful Operation - summary: Get Route Map (v2.1) + summary: Get BGP Config from NB (v2.1) tags: - Routing put: - description: Update a route map. - operationId: put-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_routemaps-config_id + description: Updates the BGP configuration from NB. + operationId: put-sdwan-v2.1-api-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id parameters: - description: The ID of the site. in: path @@ -6299,25 +4961,25 @@ paths: schema: description: Element Id type: string - - description: The ID of the route map. + - description: The ID of the BGP config. in: path - name: config_id + name: bgp_config_id required: true schema: - description: Config Id + description: Bgp 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/BGPGlobalConfigScreenV2N1' + description: Details of the bgp config to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' + $ref: '#/components/schemas/BGPGlobalConfigV2N1' description: Successful Operation '400': content: @@ -6325,30 +4987,26 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_ROUTE_MAP + - 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: 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 + - code: INVALID_JSON_COMMON_ATTR_MISMATCH schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Route Map (v2.1) + summary: Update BGP Config from NB (v2.1) tags: - Routing - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}/status: + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/bgppeers: 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: List all the BGP peer configurations from NB. + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-bgppeers parameters: - description: The ID of the site. in: path @@ -6364,27 +5022,90 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. + 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: static_route_id + name: site_id required: true schema: - description: Static Route Id + 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/BGPGlobalConfigScreenV2N1' + description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteStatus' + $ref: '#/components/schemas/BGPPeerConfigV2N1' description: Successful Operation - summary: Get Static Route Status (v2.1) + '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) 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.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 parameters: - description: The ID of the site. in: path @@ -6400,27 +5121,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/BGPGlobalConfigV2N2' + $ref: '#/components/schemas/BGPPeerQueryFilterV2N1' type: array type: object description: Successful Operation - summary: Get BGP Configs from NB (v2.2) + '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) tags: - Routing - /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/bgpconfigs/{bgp_config_id}: + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/bgppeers/status: 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: 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 @@ -6436,26 +5173,27 @@ 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: - $ref: '#/components/schemas/BGPGlobalConfigV2N2' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerStatusV2N1' + type: array + type: object description: Successful Operation - summary: Get BGP Config from NB (v2.2) + summary: Get BGP Peer Status from NB (v2.1) tags: - Routing - put: - description: Update the BGP configuration. - operationId: put-sdwan-v2.2-api-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id + /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 parameters: - description: The ID of the site. in: path @@ -6471,54 +5209,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 - 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/BGPGlobalConfigV2N2' + $ref: '#/components/schemas/BGPPeerConfigV2N1' description: Successful Operation - '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) + summary: Delete BGP Peer Config (v2.1) tags: - Routing - /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/bgppeers/status: get: - description: List all the BGP peer statuses from NB. - operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-bgppeers-status + description: Get the BGP peer configuration. + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: The ID of the site. in: path @@ -6534,27 +5244,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/BGPPeerStatusV2N2' - type: array - type: object + $ref: '#/components/schemas/BGPPeerConfigV2N1' description: Successful Operation - summary: Get BGP Peer Status from NB (v2.2) + summary: Get BGP Peer Config (v2.1) tags: - 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 + put: + description: Update the BGP peer configuration. + operationId: put-sdwan-v2.1-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: The ID of the site. in: path @@ -6570,27 +5279,61 @@ paths: schema: description: Element Id type: string - - description: The BGP peer config ID. + - description: The ID of the BGP peer. in: path - name: bgp_peer_config_id + name: bgp_peer_id required: true schema: - description: Bgp Peer Config Id + 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/BGPPeerDiscoveredPrefixesV2N2' + $ref: '#/components/schemas/BGPPeerConfigV2N1' description: Successful Operation - summary: Get BGP Discovered Prefix Information (v2.2) + '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) tags: - Routing - /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/bgppeers/{config_id}/status: + /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.2-api-sites-site_id-elements-element_id-bgppeers-config_id-status + 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 @@ -6618,15 +5361,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BGPPeerStatusV2N2' + $ref: '#/components/schemas/BGPPeerStatusV2N1' description: Successful Operation - summary: Get BGP Peer Status from NB (v2.2) + summary: Get BGP Peer Status from NB (v2.1) tags: - Routing - /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/routing_routemaps: + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists: get: - description: List all the route maps for an element. - operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-routing_routemaps + 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 @@ -6652,9 +5395,12 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N2' + $ref: '#/components/schemas/RoutingAccessListV2N1' type: array type: object + items: + $ref: '#/components/schemas/RoutingAccessListV2N1' + type: array description: Successful Operation '400': content: @@ -6666,12 +5412,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Route Map for Element (v2.2) + summary: Get Access List for Element (v2.1) tags: - Routing post: - description: Create a route map. - operationId: post-sdwan-v2.2-api-sites-site_id-elements-element_id-routing_routemaps + 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 @@ -6691,14 +5437,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapV2N2' - description: Details of the route map 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/RoutingRouteMapScreenV2N2' + $ref: '#/components/schemas/RoutingAccessListV2N1' description: Successful Operation '400': content: @@ -6710,29 +5456,17 @@ 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 Route Map (v2.2) + summary: Create AS-Path Access List (v2.1) tags: - Routing - /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/routing_routemaps/query: + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/query: post: - description: Queries the DB for limit number of route maps that match the query + description: Queries the DB for limit number of access lists that match query parameters. - operationId: post-sdwan-v2.2-api-sites-site_id-elements-element_id-routing_routemaps-query + operationId: post-sdwan-v2.1-api-sites-site_id-elements-element_id-routing_aspathaccesslists-query parameters: - description: The ID of the site. in: path @@ -6752,8 +5486,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: @@ -6764,7 +5498,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/RoutingRouteMapQueryFilterV2N2' + $ref: '#/components/schemas/RoutingAccessListQueryFilterV2N1' type: array type: object description: Successful Operation @@ -6779,13 +5513,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Route Maps (v2.2) + summary: Query DB for Access Lists (v2.1) tags: - Routing - /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/routing_routemaps/{config_id}: + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_aspathaccesslists/{config_id}: delete: - description: Delete a route map. - operationId: delete-sdwan-v2.2-api-sites-site_id-elements-element_id-routing_routemaps-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 @@ -6801,7 +5535,7 @@ paths: schema: description: Element Id type: string - - description: The ID of the route map. + - description: The ID of the access list. in: path name: config_id required: true @@ -6813,7 +5547,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N2' + $ref: '#/components/schemas/RoutingAccessListV2N1' description: Successful Operation '400': content: @@ -6821,17 +5555,17 @@ paths: example: value: _error: - - code: ROUTE_MAP_IN_USE - - code: CANNOT_DELETE_AUTOGENERATED_ROUTE_MAP + - code: ACCESS_LIST_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_ACCESS_LIST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Route Map (v2.2) + summary: Delete Access List (v2.1) tags: - Routing get: - description: Get a specific route map. - operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-routing_routemaps-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 @@ -6859,14 +5593,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapScreenV2N2' + $ref: '#/components/schemas/RoutingAccessListV2N1' description: Successful Operation - summary: Get Route Map (v2.2) + summary: Get Access List (v2.1) tags: - Routing put: - description: Update a route map. - operationId: put-sdwan-v2.2-api-sites-site_id-elements-element_id-routing_routemaps-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 @@ -6882,7 +5616,7 @@ paths: schema: description: Element Id type: string - - description: The ID of the route map. + - description: The ID of the access list. in: path name: config_id required: true @@ -6893,14 +5627,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingRouteMapV2N2' - description: Details of the route map 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/RoutingRouteMapScreenV2N2' + $ref: '#/components/schemas/RoutingAccessListV2N1' description: Successful Operation '400': content: @@ -6908,30 +5642,19 @@ paths: example: value: _error: - - code: CANNOT_UPDATE_AUTOGENERATED_ROUTE_MAP + - code: CANNOT_UPDATE_AUTOGENERATED_ACCESS_LIST - 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 + - code: INVALID_JSON_COMMON_ATTR_MISMATCH schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Route Map (v2.2) + summary: Update Access List (v2.1) tags: - Routing - /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/staticroutes: + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/routing_routemaps: get: - description: List all the static routes. - operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-staticroutes + 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 @@ -6957,16 +5680,26 @@ paths: - properties: items: items: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' type: array type: object description: Successful Operation - summary: Get Static Routes (v2.2) + '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 post: - description: Create a static route. - operationId: post-sdwan-v2.2-api-sites-site_id-elements-element_id-staticroutes + 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 @@ -6986,13 +5719,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/RoutingRouteMapV2N1' + description: Details of the route map to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' description: Successful Operation '400': content: @@ -7000,64 +5734,65 @@ paths: example: value: _error: - - code: INVALID_JSON_INPUT + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_ASSIGNED_TO_SITE + - code: NOT_SUPPORTED_BY_ELEMENT - 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: 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 schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Static Route (v2.2) + summary: Create Route Map (v2.1) tags: - Routing - /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 + /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 ID of the site. + - description: The site ID. in: path name: site_id required: true schema: description: Site Id type: string - - description: The ID of the element. + - description: The element ID. 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/RoutingRouteMapQuery' + description: Query details for route maps responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/RoutingRouteMapQueryFilterV2N1' + type: array + type: object description: Successful Operation '400': content: @@ -7065,51 +5800,18 @@ paths: example: value: _error: - - code: STATICROUTE_CONFIG_INVALID_DEVICE + - code: BAD_REQUEST + - code: ELEMENT_NOT_ASSIGNED_TO_SITE 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/StaticRouteV2N2' - description: Successful Operation - summary: Get Static Route (v2.2) + summary: Query DB for Route Maps (v2.1) tags: - Routing - put: - description: Update a static route. - operationId: put-sdwan-v2.2-api-sites-site_id-elements-element_id-staticroutes-static_route_id + /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 @@ -7125,24 +5827,19 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. + - description: The ID of the route map. in: path - name: static_route_id + name: config_id required: true schema: - description: Static Route Id + description: Config Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StaticRouteV2N2' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N2' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' description: Successful Operation '400': content: @@ -7150,36 +5847,17 @@ paths: 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: ROUTE_MAP_IN_USE + - code: CANNOT_DELETE_AUTOGENERATED_ROUTE_MAP schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Static Route (v2.2) + summary: Delete Route Map (v2.1) 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 + 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 @@ -7195,47 +5873,60 @@ paths: schema: description: Element Id type: string - - description: The ID of the static route. + - description: The BGP peer config ID. in: path - name: static_route_id + name: config_id required: true schema: - description: Static Route Id + description: Config Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteStatusV2N2' + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' description: Successful Operation - summary: Get Static Route Status (v2.2) + summary: Get Route Map (v2.1) tags: - Routing - /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 + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/BGPPeerQuery' - description: Query Details for BGP Peers + $ref: '#/components/schemas/RoutingRouteMapV2N1' + description: Details of the route map to be updated responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/BGPPeerQueryFilterV2N3' - type: array - type: object + $ref: '#/components/schemas/RoutingRouteMapScreenV2N1' description: Successful Operation '400': content: @@ -7243,17 +5934,29 @@ paths: example: value: _error: - - code: BAD_QUERY_REQUEST + - 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 schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for BGP Peers (v2.3) + summary: Update Route Map (v2.1) tags: - Routing - /sdwan/v2.3/api/sites/{site_id}/elements/{element_id}/bgpconfigs: + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/staticroutes: get: - description: List all the BGP configurations from NB. - operationId: get-sdwan-v2.3-api-sites-site_id-elements-element_id-bgpconfigs + description: List all the static routes. + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-staticroutes parameters: - description: The ID of the site. in: path @@ -7279,17 +5982,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/BGPGlobalConfigV2N3' + $ref: '#/components/schemas/StaticRouteV2N1' type: array type: object description: Successful Operation - summary: Get BGP Configs from NB (v2.3) + summary: Get Static Routes (v2.1) tags: - Routing - /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 + post: + description: Create a static route. + operationId: post-sdwan-v2.1-api-sites-site_id-elements-element_id-staticroutes parameters: - description: The ID of the site. in: path @@ -7305,26 +6007,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/StaticRouteV2N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPGlobalConfigV2N3' + $ref: '#/components/schemas/StaticRouteV2N1' description: Successful Operation - summary: Get BGP Config from NB (v2.3) + '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) tags: - Routing - put: - description: Update the BGP configuration. - operationId: put-sdwan-v2.3-api-sites-site_id-elements-element_id-bgpconfigs-bgp_config_id + /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 parameters: - description: The ID of the site. in: path @@ -7340,54 +6060,26 @@ paths: schema: description: Element Id type: string - - description: The ID of the BGP config. + - description: The ID of the static route. in: path - name: bgp_config_id + name: static_route_id required: true schema: - description: Bgp Config Id + description: Static Route 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/BGPGlobalConfigV2N3' + $ref: '#/components/schemas/StaticRouteV2N1' description: Successful Operation - '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) + summary: Delete Static Route (v2.1) tags: - Routing - /sdwan/v2.3/api/sites/{site_id}/elements/{element_id}/bgppeers: get: - description: List all the BGP peer configurations from NB. - operationId: get-sdwan-v2.3-api-sites-site_id-elements-element_id-bgppeers + description: Get a specific static route. + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-staticroutes-static_route_id parameters: - description: The ID of the site. in: path @@ -7403,26 +6095,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: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/BGPPeerConfigV2N3' - type: array - type: object + $ref: '#/components/schemas/StaticRouteV2N1' description: Successful Operation - summary: Get BGP Peer Configs from NB (v2.3) + summary: Get Static Route (v2.1) tags: - Routing - post: - description: Create a BGP peer configuration. - operationId: post-sdwan-v2.3-api-sites-site_id-elements-element_id-bgppeers + put: + description: Update a static route. + operationId: put-sdwan-v2.1-api-sites-site_id-elements-element_id-staticroutes-static_route_id parameters: - description: The ID of the site. in: path @@ -7438,18 +6130,24 @@ 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/BGPPeerConfigScreenV2N3' - description: Details of the BGP peer config to be created + $ref: '#/components/schemas/StaticRouteV2N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N3' + $ref: '#/components/schemas/StaticRouteV2N1' description: Successful Operation '400': content: @@ -7457,37 +6155,26 @@ 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_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.3) + summary: Update Static Route (v2.1) 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 + /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 parameters: - description: The ID of the site. in: path @@ -7501,8 +6188,30 @@ paths: name: element_id required: true schema: - description: Element Id + 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: @@ -7533,13 +6242,13 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for BGP Peers (v2.3) + summary: Query DB for BGP Peers (v2.2) tags: - Routing - /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 + /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 @@ -7555,26 +6264,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/BGPPeerConfigV2N3' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPGlobalConfigV2N2' + type: array + type: object description: Successful Operation - summary: Delete BGP Peer Config (v2.3) + summary: Get BGP Configs from NB (v2.2) tags: - Routing + /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/bgpconfigs/{bgp_config_id}: get: - description: Get the BGP peer configuration. - operationId: get-sdwan-v2.3-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + 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 @@ -7590,26 +6300,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/BGPPeerConfigV2N3' + $ref: '#/components/schemas/BGPGlobalConfigV2N2' description: Successful Operation - summary: Get BGP Peer Config (v2.3) + summary: Get BGP Config from NB (v2.2) tags: - Routing put: - description: Update the BGP peer configuration. - operationId: put-sdwan-v2.3-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + 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 @@ -7625,25 +6335,25 @@ 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/BGPPeerConfigScreenV2N3' - description: Details of the BGP peer config to be created + $ref: '#/components/schemas/BGPGlobalConfigScreenV2N2' + description: Details of the bgp config to be updated responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N3' + $ref: '#/components/schemas/BGPGlobalConfigV2N2' description: Successful Operation '400': content: @@ -7651,8 +6361,6 @@ 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 @@ -7661,27 +6369,20 @@ 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 Peer Config (v2.3) + summary: Update BGP Config (v2.2) tags: - Routing - /sdwan/v2.3/api/sites/{site_id}/elements/{element_id}/staticroutes: + /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/bgppeers: get: - description: List all the static routes. - operationId: get-sdwan-v2.3-api-sites-site_id-elements-element_id-staticroutes + description: List all the BGP peer configurations from NB. + operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-bgppeers parameters: - description: The ID of the site. in: path @@ -7707,16 +6408,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/StaticRouteV2N3' + $ref: '#/components/schemas/BGPPeerConfigV2N2' type: array type: object description: Successful Operation - summary: Get Static Routes (v2.3) + summary: Get BGP Peer Configs from NB (v2.2) tags: - Routing post: - description: Create a static route. - operationId: post-sdwan-v2.3-api-sites-site_id-elements-element_id-staticroutes + description: Create a BGP peer configuration. + operationId: post-sdwan-v2.2-api-sites-site_id-elements-element_id-bgppeers parameters: - description: The ID of the site. in: path @@ -7736,13 +6437,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N3' + $ref: '#/components/schemas/BGPGlobalConfigScreenV2N2' + description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N3' + $ref: '#/components/schemas/BGPPeerConfigV2N2' description: Successful Operation '400': content: @@ -7750,36 +6452,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_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: 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: Create Static Route (v2.3) + summary: Create BGP Peer Config (v2.2) tags: - Routing - /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 + /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 parameters: - description: The ID of the site. in: path @@ -7795,19 +6498,25 @@ 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/BGPPeerQuery' + description: Query Details for BGP Peers responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StaticRouteV2N3' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/BGPPeerQueryFilterV2N2' + type: array + type: object description: Successful Operation '400': content: @@ -7815,16 +6524,17 @@ paths: example: value: _error: - - code: STATICROUTE_CONFIG_INVALID_DEVICE + - code: BAD_QUERY_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Static Route (v2.3) + summary: Query DB for BGP Peers (v2.2) tags: - Routing - get: - description: Get a specific static route. - operationId: get-sdwan-v2.3-api-sites-site_id-elements-element_id-staticroutes-static_route_id + /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 parameters: - description: The ID of the site. in: path @@ -7840,26 +6550,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/StaticRouteV2N3' + $ref: '#/components/schemas/BGPPeerConfigV2N2' description: Successful Operation - summary: Get Static Route (v2.3) + summary: Delete BGP Peer Config (v2.2) tags: - Routing - put: - description: Update a static route. - operationId: put-sdwan-v2.3-api-sites-site_id-elements-element_id-staticroutes-static_route_id + get: + description: Get the BGP peer configuration. + operationId: get-sdwan-v2.2-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: The ID of the site. in: path @@ -7875,134 +6585,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 - 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: - 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: 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 - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The ID of the element. + - description: The ID of the BGP peer. in: path - name: element_id + name: bgp_peer_id required: true schema: - description: Element Id + description: Bgp Peer Id type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/BGPPeerConfigV2N4' - type: array - type: object + $ref: '#/components/schemas/BGPPeerConfigV2N2' description: Successful Operation - summary: Get BGP Peer Configs from NB (v2.4) + summary: Get BGP Peer Config (v2.2) tags: - Routing - post: - description: Create a BGP peer configuration. - operationId: post-sdwan-v2.4-api-sites-site_id-elements-element_id-bgppeers + put: + description: Update the BGP peer configuration. + operationId: put-sdwan-v2.2-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id parameters: - description: The ID of the site. in: path @@ -8018,18 +6620,25 @@ 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/BGPPeerConfigScreenV2N4' + $ref: '#/components/schemas/BGPGlobalConfigScreenV2N2' description: Details of the BGP peer config to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N4' + $ref: '#/components/schemas/BGPPeerConfigV2N2' description: Successful Operation '400': content: @@ -8053,22 +6662,21 @@ 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_PEER_IP_CONFIG_NOT_SUPPORTED + - code: BGP_CONFIG_INVALID_MD5_UNSET_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create BGP Peer Config (v2.4) + summary: Update BGP Peer Config (v2.2) tags: - Routing - /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 + /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 parameters: - description: The ID of the site. in: path @@ -8084,43 +6692,89 @@ 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/BGPPeerQueryFilterV2N4' + $ref: '#/components/schemas/StaticRouteV2N2' 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: BAD_QUERY_REQUEST + - 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: Query DB for BGP Peers (v2.4) + summary: Create Static Route (v2.2) tags: - Routing - /sdwan/v2.4/api/sites/{site_id}/elements/{element_id}/bgppeers/{bgp_peer_id}: + /sdwan/v2.2/api/sites/{site_id}/elements/{element_id}/staticroutes/{static_route_id}: delete: - description: Delete the BGP peer configuration. - operationId: delete-sdwan-v2.4-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + description: Delete a static route. + operationId: delete-sdwan-v2.2-api-sites-site_id-elements-element_id-staticroutes-static_route_id parameters: - description: The ID of the site. in: path @@ -8136,26 +6790,36 @@ 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/BGPPeerConfigV2N4' + $ref: '#/components/schemas/StaticRouteV2N2' description: Successful Operation - summary: Delete BGP Peer Config (v2.4) + '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) tags: - Routing get: - description: Get the BGP peer configuration. - operationId: get-sdwan-v2.4-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + 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 @@ -8171,26 +6835,26 @@ 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/BGPPeerConfigV2N4' + $ref: '#/components/schemas/StaticRouteV2N2' description: Successful Operation - summary: Get BGP Peer Config (v2.4) + summary: Get Static Route (v2.2) tags: - Routing put: - description: Update the BGP peer configuration. - operationId: put-sdwan-v2.4-api-sites-site_id-elements-element_id-bgppeers-bgp_peer_id + 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 @@ -8206,25 +6870,24 @@ 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigScreenV2N4' - description: Details of the BGP peer config to be created + $ref: '#/components/schemas/StaticRouteV2N2' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/BGPPeerConfigV2N4' + $ref: '#/components/schemas/StaticRouteV2N2' description: Successful Operation '400': content: @@ -8232,106 +6895,66 @@ 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: 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.4) - tags: - - Routing - /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: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/PrefixQueryFilterV3' - type: array - type: object - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_QUERY_REQUEST + - 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: Query Prefix Set (v3.0) + summary: Update Static Route (v2.2) tags: - Routing - /sdwan/v3.1/api/prefixes/query: - post: - description: Query the prefix set. - operationId: post-sdwan-v3.1-api-prefixes-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PrefixQueryV3N1' - description: Query Details for prefixes + /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 responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/PrefixQueryFilterV3N1' - type: array - type: object + $ref: '#/components/schemas/StaticRouteStatusV2N2' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_QUERY_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Prefix Set (v3.1) + summary: Get Static Route Status (v2.2) tags: - Routing servers: diff --git a/openapi-specs/sdwan/unified/SecurityPolicy.yaml b/openapi-specs/sdwan/unified/SecurityPolicy.yaml index 7f5c0f7ec..79047b1c4 100644 --- a/openapi-specs/sdwan/unified/SecurityPolicy.yaml +++ b/openapi-specs/sdwan/unified/SecurityPolicy.yaml @@ -2,21 +2,9 @@ components: schemas: Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -30,28 +18,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 ElementSecurityZone: properties: id: @@ -323,6 +289,10 @@ components: ' type: string + required: + - path + - site + - elements GlobalPrefixQueryFilter: properties: description: @@ -360,48 +330,6 @@ components: type: array required: - name - GlobalPrefixQueryFilterV2N1: - properties: - description: - description: 'The description of the priority policy global prefix. - - ' - id: - description: 'The ID of the priority policy global prefix. - - ' - type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the priority policy global prefix. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'Lists the IPv6 addresses of the priority policy global prefix. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - name: - description: 'The name of the priority policy global prefix. - - ' - 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. \n" - items: - description: Tags - type: string - type: array - required: - - name ListQueryResponse: properties: count: @@ -660,91 +588,6 @@ components: type: array required: - name - SecurityPolicyGlobalPrefixScreenV2N1: - properties: - description: - description: 'The description of the security policy global prefix. - - ' - id: - description: 'The ID of the security policy global prefix. - - ' - type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the priority policy global prefix. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'Lists the IPv6 addresses of the security policy global prefix. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - name: - description: 'The name of the security policy global prefix. - - ' - 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. \n" - items: - description: Tags - type: string - type: array - required: - - name - SecurityPolicyGlobalPrefixV2N1: - properties: - description: - description: 'The description of the security policy global prefix. - - ' - id: - description: 'The ID of the security policy global prefix. - - ' - type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the priority policy global prefix. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - ipv6_prefixes: - description: 'Lists the IPv6 addresses of the security policy global prefix. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - name: - description: 'The name of the security policy global prefix. - - ' - 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. - - ' - items: - description: Tags - type: string - type: array - required: - - name SecurityPolicyRule: properties: action: @@ -1240,7 +1083,7 @@ components: type: array required: - name - SecurityPolicyV2N1RuleQueryFilter: + SecurityPolicyV2Rule: properties: action: description: "The action taken for traffic matching this rule. It determine\ @@ -1248,7 +1091,8 @@ components: \ zone should respond. \n" type: string app_def_ids: - description: 'The security policy rule application ID. + description: 'The number of app definition IDs that have applied security + policy rules. Maximum 16 applications can be specified in a rule. ' items: @@ -1276,7 +1120,8 @@ components: type: string type: array enabled: - description: "The security policy rule, if enabled. \n" + description: "The security policy rules based on rules that are enabled.\ + \ \n" type: boolean id: description: 'The security policy rule ID. @@ -1290,7 +1135,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 @@ -1319,16 +1164,11 @@ components: description: Tags type: string type: array - user_or_group: - $ref: '#/components/schemas/UserGroup' - description: 'The details of the user or group. - - ' required: - enabled - action - name - SecurityPolicyV2N1RuleScreen: + SecurityPolicyV2RuleQueryFilter: properties: action: description: "The action taken for traffic matching this rule. It determine\ @@ -1336,7 +1176,8 @@ components: \ zone should respond. \n" type: string app_def_ids: - description: 'The security policy rule application ID. + description: 'The number of app definition IDs that have applied security + policy rules. Maximum 16 applications can be specified in a rule. ' items: @@ -1364,7 +1205,8 @@ components: type: string type: array enabled: - description: "The security policy rule, if enabled. \n" + description: "The security policy rules based on rules that are enabled.\ + \ \n" type: boolean id: description: 'The security policy rule ID. @@ -1374,11 +1216,16 @@ components: name: description: 'The name of the security policy rule. Max size = 128. + ' + type: string + policyset_id: + description: 'The policy set ID. + ' 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 @@ -1407,16 +1254,11 @@ components: description: Tags type: string type: array - user_or_group: - $ref: '#/components/schemas/UserGroup' - description: 'The details of the user or group. - - ' required: - enabled - action - name - SecurityPolicyV2Rule: + SecurityPolicyV2RuleScreen: properties: action: description: "The action taken for traffic matching this rule. It determine\ @@ -1489,10 +1331,9 @@ components: type: string type: array tags: - description: 'A information field that can be added to identify the security - policy rule. Maximum 10 unique tags of length 1024 each are allowed. - - ' + description: "A information field that can be added to identify the security\ + \ policy rule. Maximum 10 unique tags of length 1024 each are allowed.\ + \ \n" items: description: Tags type: string @@ -1501,86 +1342,39 @@ components: - enabled - action - name - SecurityPolicyV2RuleQueryFilter: + SecurityPolicyV2Set: properties: - action: - 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" + clone_from: + description: "Policy sets cloned from existing policy sets. \n" type: string - app_def_ids: - description: 'The number of app definition IDs that have applied security - policy rules. Maximum 16 applications can be specified in a rule. - - ' - items: - description: App Def Ids - type: string - type: array + defaultrule_policyset: + description: "The default rule of the policy set. \n" + type: boolean description: - description: 'The description of the security policy rule. Max size = 256. - - ' - destination_prefix_ids: - 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: 'The destination zone IDs. Max list of zone IDs is 16. + description: 'The description of the security policy set. Max size = 256. ' - items: - description: Destination Zone Ids - type: string - type: array - enabled: - description: "The security policy rules based on rules that are enabled.\ - \ \n" - type: boolean id: - description: 'The security policy rule ID. + description: 'The security policy set ID. ' type: string name: - description: 'The name of the security policy rule. Max size = 128. - - ' - type: string - policyset_id: - description: 'The policy set ID. + description: 'The name of the security policy set. Max size = 128. ' type: string - 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: 'The source prefix IDs. Max list of IDs is 16. - - ' - items: - description: Source Prefix Ids - type: string - type: array - source_zone_ids: - description: 'The source zone IDs. Max list of IDs is 16. + policyrule_order: + description: 'The order for the execution of the policy rule. ' items: - description: Source Zone Ids + description: Policyrule Order type: string type: array tags: description: 'A information field that can be added to identify the security - policy rule. Maximum 10 unique tags of length 1024 each are allowed. + policy set. Maximum 10 unique tags of length 1024 each are allowed. ' items: @@ -1588,236 +1382,23 @@ components: type: string type: array required: - - enabled - - action - name - SecurityPolicyV2RuleScreen: + SecurityPolicyV2SetQuery: properties: - action: - 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: 'The number of app definition IDs that have applied security - policy rules. Maximum 16 applications can be specified in a rule. + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of security policies V2 that match the + query parameters. ' - items: - description: App Def Ids - type: string - type: array - description: - description: 'The description of the security policy rule. Max size = 256. + dest_page: + description: 'The destination page. ' - destination_prefix_ids: - 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: 'The destination zone IDs. Max list of zone IDs is 16. - - ' - items: - description: Destination Zone Ids - type: string - type: array - enabled: - description: "The security policy rules based on rules that are enabled.\ - \ \n" - type: boolean - id: - description: 'The security policy rule ID. - - ' - type: string - name: - description: 'The name of the security policy rule. Max size = 128. - - ' - type: string - 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: 'The source prefix IDs. Max list of IDs is 16. - - ' - items: - description: Source Prefix Ids - type: string - type: array - source_zone_ids: - description: 'The source zone IDs. Max list of IDs is 16. - - ' - items: - description: Source Zone Ids - type: string - type: array - tags: - description: "A information field that can be added to identify the security\ - \ policy rule. Maximum 10 unique tags of length 1024 each are allowed.\ - \ \n" - items: - description: Tags - type: string - type: array - required: - - enabled - - action - - name - SecurityPolicyV2RuleV2N1: - properties: - action: - 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: 'The security policy rule application ID. - - ' - items: - description: App Def Ids - type: string - type: array - description: - description: 'The description of the security policy rule. Max size = 256. - - ' - destination_prefix_ids: - 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: 'The destination zone IDs. Max list of zone IDs is 16. - - ' - items: - description: Destination Zone Ids - type: string - type: array - enabled: - description: "The security policy rule, if enabled. \n" - type: boolean - id: - description: 'The security policy rule ID. - - ' - type: string - name: - description: 'The name of the security policy rule. Max size = 128. - - ' - type: string - 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: 'The source prefix IDs. Max list of IDs is 16. - - ' - items: - description: Source Prefix Ids - type: string - type: array - source_zone_ids: - description: 'The source zone IDs. Max list of IDs is 16. - - ' - items: - description: Source Zone Ids - type: string - type: array - tags: - 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: "The details of the user or group. \n" - required: - - enabled - - action - - name - SecurityPolicyV2Set: - properties: - clone_from: - description: "Policy sets cloned from existing policy sets. \n" - type: string - defaultrule_policyset: - description: "The default rule of the policy set. \n" - type: boolean - description: - description: 'The description of the security policy set. Max size = 256. - - ' - id: - description: 'The security policy set ID. - - ' - type: string - name: - description: 'The name of the security policy set. Max size = 128. - - ' - type: string - policyrule_order: - description: 'The order for the execution of the policy rule. - - ' - items: - description: Policyrule Order - type: string - type: array - tags: - description: 'A information field that can be added to identify the security - policy set. Maximum 10 unique tags of length 1024 each are allowed. - - ' - items: - description: Tags - type: string - type: array - required: - - name - SecurityPolicyV2SetQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of security policies V2 that match the - query parameters. - - ' - dest_page: - description: 'The destination page. - - ' - format: int32 - type: integer - getDeleted: - description: 'The number of security policies V2 deleted for a time frame. + format: int32 + type: integer + getDeleted: + description: 'The number of security policies V2 deleted for a time frame. ' type: boolean @@ -2369,192 +1950,84 @@ components: description: Tags type: string type: array - SitePrefixAssociationQueryFilterV2N1: + SiteSecurityPolicyV2PrefixAssociation: properties: id: - description: 'The ID of the site prefix. + description: 'The ID of the security policy v2 prefix association. ' type: string ipv4_prefixes: - description: 'The individual IP address. + description: 'Lists the IPv4 addresses of the security policy v2 prefix + association. ' items: description: Ipv4 Prefixes type: string type: array - ipv6_prefixes: - description: 'Lists the IPv6 address. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array prefix_id: description: "The IP Prefix ID that associates with a site. \n" type: string - site_id: - description: 'The site ID binding the prefix. - - ' - type: string tags: - description: 'A information field that can be added to identify the site - prefix. Maximum 10 unique tags of length 1024 each are allowed. + description: 'An information field that can be added to identify the security + policy v2 prefix association. Maximum 10 unique tags of length 1024 each + are allowed. ' items: description: Tags type: string type: array - SiteSecurityPolicyV2N1PrefixAssociation: + SiteSecurityPolicyV2PrefixAssociationScreen: properties: id: - description: 'The ID of the site prefix. + description: 'The ID of the security policy v2 prefix association. ' type: string ipv4_prefixes: - description: 'The individual IP address. + description: 'Lists the IPv4 addresses of the security policy v2 prefix + association. ' items: description: Ipv4 Prefixes type: string type: array - ipv6_prefixes: - description: 'Lists the IPv6 address. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array prefix_id: description: "The IP Prefix ID that associates with a site. \n" type: string tags: - description: 'A information field that can be added to identify the site - prefix. Maximum 10 unique tags of length 1024 each are allowed. + description: 'An information field that can be added to identify the security + policy v2 prefix association. Maximum 10 unique tags of length 1024 each + are allowed. ' items: description: Tags type: string type: array - SiteSecurityPolicyV2N1PrefixAssociationScreen: + SiteSecurityZoneNetworkAssociationQueryFilter: properties: id: - description: 'The ID of the site prefix. + description: 'The ID of the security zone. ' type: string - ipv4_prefixes: - description: 'The individual IP address. + networks: + description: 'The details of the network and network type. ' items: - description: Ipv4 Prefixes - type: string + $ref: '#/components/schemas/SiteContext' type: array - ipv6_prefixes: - description: 'Lists the IPv6 address. - - ' - items: - description: Ipv6 Prefixes - type: string - type: array - prefix_id: - description: "The IP Prefix ID that associates with a site. \n" - type: string - tags: - description: "A information field that can be added to identify the site\ - \ prefix. Maximum 10 unique tags of length 1024 each are allowed. \n" - items: - description: Tags - type: string - type: array - SiteSecurityPolicyV2PrefixAssociation: - properties: - id: - description: 'The ID of the security policy v2 prefix association. - - ' - type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the security policy v2 prefix - association. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - prefix_id: - description: "The IP Prefix ID that associates with a site. \n" - type: string - tags: - description: 'An information field that can be added to identify the security - policy v2 prefix association. Maximum 10 unique tags of length 1024 each - are allowed. - - ' - items: - description: Tags - type: string - type: array - SiteSecurityPolicyV2PrefixAssociationScreen: - properties: - id: - description: 'The ID of the security policy v2 prefix association. - - ' - type: string - ipv4_prefixes: - description: 'Lists the IPv4 addresses of the security policy v2 prefix - association. - - ' - items: - description: Ipv4 Prefixes - type: string - type: array - prefix_id: - description: "The IP Prefix ID that associates with a site. \n" - type: string - tags: - description: 'An information field that can be added to identify the security - policy v2 prefix association. Maximum 10 unique tags of length 1024 each - are allowed. - - ' - items: - description: Tags - type: string - type: array - SiteSecurityZoneNetworkAssociationQueryFilter: - properties: - id: - description: 'The ID of the security zone. - - ' - type: string - networks: - description: 'The details of the network and network type. - - ' - items: - $ref: '#/components/schemas/SiteContext' - type: array - site_id: - description: "The site ID configured for the element security zone. \ - \ \n" - type: string - zone_id: - description: 'The ID of the security zone. + site_id: + description: "The site ID configured for the element security zone. \ + \ \n" + type: string + zone_id: + description: 'The ID of the security zone. ' type: string @@ -2562,24 +2035,6 @@ components: - site_id - networks - zone_id - UserGroup: - properties: - user_group_ids: - description: 'The user group IDs. - - ' - items: - description: User Group Ids - type: string - type: array - user_ids: - description: 'The user IDs. - - ' - items: - description: User Ids - type: string - type: array info: contact: {} description: List of APIs used to manage your security policy rules that include @@ -5162,614 +4617,6 @@ paths: summary: Query Security Zone for NB API (v2.0) tags: - Security Policy - /sdwan/v2.1/api/ngfwsecuritypolicyglobalprefixes: - get: - description: List all the security policy V2 global prefixes for a tenant. - operationId: get-sdwan-v2.1-api-ngfwsecuritypolicyglobalprefixes - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SecurityPolicyGlobalPrefixV2N1' - type: array - type: object - description: Successful Operation - summary: Get Security Policy Global Prefixes (v2.1) - tags: - - Security Policy - post: - description: Create a security policy V2 global prefix. - operationId: post-sdwan-v2.1-api-ngfwsecuritypolicyglobalprefixes - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyGlobalPrefixScreenV2N1' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyGlobalPrefixV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_INPUT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - - code: INVALID_PREFIX - - code: NAME_REQD - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_TAG - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Security Policy Global Prefix (v2.1) - tags: - - Security Policy - /sdwan/v2.1/api/ngfwsecuritypolicyglobalprefixes/query: - post: - description: Query the security policy V2 global prefixes of a tenant. - operationId: post-sdwan-v2.1-api-ngfwsecuritypolicyglobalprefixes-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GlobalPrefixQueryFilterV2N1' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/GlobalPrefixQueryFilter' - type: array - type: object - description: Successful Operation - summary: Query Security Policy Global Prefixes (v2.1) - tags: - - Security Policy - /sdwan/v2.1/api/ngfwsecuritypolicyglobalprefixes/{prefix_id}: - delete: - description: Delete a security policy V2 global prefix by the tenant ID and - the prefix ID. - operationId: delete-sdwan-v2.1-api-ngfwsecuritypolicyglobalprefixes-prefix_id - parameters: - - description: ID of the security policy global prefix. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyGlobalPrefixV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: PREFIX_IS_USED_BY_RULE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Security Policy Global Prefix (v2.1) - tags: - - Security Policy - get: - description: List a security policy V2 global prefix by the tenant ID and the - prefix ID. - operationId: get-sdwan-v2.1-api-ngfwsecuritypolicyglobalprefixes-prefix_id - parameters: - - description: ID of the security policy global prefix. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyGlobalPrefixV2N1' - description: Successful Operation - summary: Get Security Policy Global Prefix (v2.1) - tags: - - Security Policy - put: - description: Update a security policy V2 global prefix by the tenant ID and - the prefix ID. - operationId: put-sdwan-v2.1-api-ngfwsecuritypolicyglobalprefixes-prefix_id - parameters: - - description: ID of the security policy global prefix. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyGlobalPrefixScreenV2N1' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyGlobalPrefixV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_INPUT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_PREFIX - - code: NAME_REQD - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_TAG - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Security Policy Global Prefix (v2.1) - tags: - - Security Policy - /sdwan/v2.1/api/ngfwsecuritypolicylocalprefixes/query: - post: - description: Query the security policy v2 local prefix site associations of - a tenant. - operationId: post-sdwan-v2.1-api-ngfwsecuritypolicylocalprefixes-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SitePrefixAssociationQuery' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SitePrefixAssociationQueryFilterV2N1' - type: array - type: object - description: Successful Operation - summary: Query Security Policy Local Prefixes (v2.1) - tags: - - Security Policy - /sdwan/v2.1/api/ngfwsecuritypolicyrules/query: - post: - description: Query the security policy v2 rules of a tenant. - operationId: post-sdwan-v2.1-api-ngfwsecuritypolicyrules-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyV2N1RuleQueryFilter' - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SecurityPolicyV2N1RuleQueryFilter' - type: array - type: object - description: Successful Operation - summary: Query Security Policy Rules (v2.1) - tags: - - Security Policy - /sdwan/v2.1/api/ngfwsecuritypolicysets/{policy_set_id}/ngfwsecuritypolicyrules: - get: - description: List all the security policy V2 rules under a policy set. - operationId: get-sdwan-v2.1-api-ngfwsecuritypolicysets-policy_set_id-ngfwsecuritypolicyrules - parameters: - - description: ID of the security policy v2 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' - - properties: - items: - items: - $ref: '#/components/schemas/SecurityPolicyV2RuleV2N1' - type: array - type: object - description: Successful Operation - summary: Get Security Policy Rules under Policy Set (v2.1) - tags: - - Security Policy - post: - description: Create a security policy V2 rule under a policy set. - operationId: post-sdwan-v2.1-api-ngfwsecuritypolicysets-policy_set_id-ngfwsecuritypolicyrules - parameters: - - description: ID of the security policy v2 set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyV2N1RuleScreen' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyV2RuleV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_INPUT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Security Policy Rules under Policy Set (v2.1) - tags: - - Security Policy - /sdwan/v2.1/api/ngfwsecuritypolicysets/{policy_set_id}/ngfwsecuritypolicyrules/{policy_rule_id}: - delete: - description: Delete an existing security policy V2 rule under a policy set. - operationId: delete-sdwan-v2.1-api-ngfwsecuritypolicysets-policy_set_id-ngfwsecuritypolicyrules-policy_rule_id - parameters: - - description: ID of the security policy v2 set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: ID of the security policy v2 rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyV2RuleV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: POLICYRULE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Security Policy Rules under Policy Set (v2.1) - tags: - - Security Policy - get: - description: List an existing security policy V2 rule under a policy set. - operationId: get-sdwan-v2.1-api-ngfwsecuritypolicysets-policy_set_id-ngfwsecuritypolicyrules-policy_rule_id - parameters: - - description: ID of the security policy v2 set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: ID of the security policy v2 rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyV2RuleV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: POLICYRULE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Security Policy Rules under Policy Set (v2.1) - tags: - - Security Policy - put: - description: Update an existing security policy V2 rule under a policy set. - operationId: put-sdwan-v2.1-api-ngfwsecuritypolicysets-policy_set_id-ngfwsecuritypolicyrules-policy_rule_id - parameters: - - description: ID of the security policy v2 set. - in: path - name: policy_set_id - required: true - schema: - description: Policy Set Id - type: string - - description: ID of the security policy v2 rule. - in: path - name: policy_rule_id - required: true - schema: - description: Policy Rule Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyV2N1RuleScreen' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyV2RuleV2N1' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_INPUT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: INVALID_REQUEST_DUPLICATE_KEY - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Security Policy Rules under Policy Set (v2.1) - tags: - - Security Policy - /sdwan/v2.1/api/sites/{site_id}/ngfwsecuritypolicylocalprefixes: - get: - description: List all the security policy v2 local prefix site associations - for a site. - operationId: get-sdwan-v2.1-api-sites-site_id-ngfwsecuritypolicylocalprefixes - parameters: - - description: The 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/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SiteSecurityPolicyV2N1PrefixAssociation' - type: array - type: object - description: Successful Operation - summary: Get Security Policy Local Prefix Site Association (v2.1) - tags: - - Security Policy - post: - description: Create a security policy v2 local prefix site association. - operationId: post-sdwan-v2.1-api-sites-site_id-ngfwsecuritypolicylocalprefixes - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SiteSecurityPolicyV2N1PrefixAssociationScreen' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SiteSecurityPolicyV2N1PrefixAssociation' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_INPUT - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Security Policy Local Prefix Site Association (v2.1) - tags: - - Security Policy - /sdwan/v2.1/api/sites/{site_id}/ngfwsecuritypolicylocalprefixes/{prefix_id}: - delete: - description: Delete an existing security policy v2 local prefix site association. - operationId: delete-sdwan-v2.1-api-sites-site_id-ngfwsecuritypolicylocalprefixes-prefix_id - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The Prefix ID that associates with a site. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SiteSecurityPolicyV2N1PrefixAssociation' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete Security Policy Local Prefix Site Association (v2.1) - tags: - - Security Policy - get: - description: List an existing security policy v2 local prefix assocation by - its ID. - operationId: get-sdwan-v2.1-api-sites-site_id-ngfwsecuritypolicylocalprefixes-prefix_id - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The Prefix ID that associates with a site. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SiteSecurityPolicyV2N1PrefixAssociation' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Get Security Policy Local Prefix Site Association (v2.1) - tags: - - Security Policy - put: - description: Update an existing security policy v2 local prefix site association. - operationId: put-sdwan-v2.1-api-sites-site_id-ngfwsecuritypolicylocalprefixes-prefix_id - parameters: - - description: The ID of the site. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: The Prefix ID that associates with a site. - in: path - name: prefix_id - required: true - schema: - description: Prefix Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SiteSecurityPolicyV2N1PrefixAssociationScreen' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SiteSecurityPolicyV2N1PrefixAssociation' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_INPUT - - code: SITE_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Update Security Policy Local Prefix Site Association (v2.1) - tags: - - Security Policy servers: - url: https://api.sase.paloaltonetworks.com tags: diff --git a/openapi-specs/sdwan/unified/Service&DCGroups.yaml b/openapi-specs/sdwan/unified/Service&DCGroups.yaml index a81bcdd18..8bc3873fd 100644 --- a/openapi-specs/sdwan/unified/Service&DCGroups.yaml +++ b/openapi-specs/sdwan/unified/Service&DCGroups.yaml @@ -34,21 +34,9 @@ components: type: string Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -62,28 +50,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 Error: properties: _error: @@ -231,15 +197,37 @@ components: ' format: float type: number + SEPLivelinessProbe: + properties: + http: + description: 'The values for probing interval, failure count, HTTP status + codes, and URL. + + ' + items: + $ref: '#/components/schemas/HttpProbe' + type: array + icmp_ping: + description: 'The values for probing interval, failure count, and IP address. + + ' + items: + $ref: '#/components/schemas/IcmpPingProbe' + type: array SEPLivelinessProbeV2N2: properties: http: - description: 'Http: Valid ' + description: 'The values for probing interval, failure count, HTTP status + codes, and URL. + + ' items: $ref: '#/components/schemas/HttpProbe' type: array icmp_ping: - description: 'Icmp Ping: Valid ' + description: 'The values for probing interval, failure count, and IP address. + + ' items: $ref: '#/components/schemas/IcmpPingProbe' type: array @@ -500,24 +488,11 @@ components: required: - service_bindings - name - ServiceEndpointV2N2: + ServiceEndpoint: properties: - address: - $ref: '#/components/schemas/Address' - description: 'The address of the endpoint location. - - ' admin_up: description: 'All data center sites are automatically added when Admin Up is selected, which means that it can accept traffic per network policy. - If not selected, the endpoint is not used in path selection for forwarding - traffic. - - ' - type: boolean - allow_enterprise_traffic: - description: 'Explicitly allow enterprise traffic to transit through the - cloud security service. ' type: boolean @@ -530,26 +505,11 @@ components: ' type: string - liveliness_probe: - $ref: '#/components/schemas/SEPLivelinessProbeV2N2' - description: 'The information on liveliness probing. - - ' - location: - $ref: '#/components/schemas/Location' - description: 'The service endpoint label representing a specific location. - - ' name: description: 'The name of the service endpoint. Max size = 128. ' type: string - service_link_peers: - $ref: '#/components/schemas/ServiceLinkPeers' - description: 'The value of the hostname and IP addresses. - - ' site_id: description: "The site ID. \n" type: string @@ -575,63 +535,98 @@ components: - admin_up - type - name - ServiceEndpointV2N3: + ServiceEndpointQuery: properties: - address: - $ref: '#/components/schemas/Address' - description: 'The address of the endpoint location. + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of service endpoint that match the query + parameters. ' - admin_up: - description: 'All data center sites are automatically added when Admin Up - is selected, which means that it can accept traffic per network policy. - If not selected, the endpoint is not used in path selection for forwarding - traffic. + dest_page: + description: 'The destination page. ' - type: boolean - allow_enterprise_traffic: - description: 'Explicitly allow enterprise traffic to transit through the - cloud security service. + format: int32 + type: integer + getDeleted: + description: 'The number of service endpoint deleted for a time frame. ' type: boolean - description: - description: 'The description of the service endpoint. Max size = 256. + group_by: + description: 'Group the service endpoint for the query. ' + items: + description: Group By + type: string + type: array id: - description: 'The ID of the service endpoint. + description: "Lists the service endpoint by ID. \n" + type: string + last_query_ts: + description: 'Return the ID of a specified query in the current session. ' - type: string - liveliness_probe: - $ref: '#/components/schemas/SEPLivelinessProbeV2N2' - description: 'The information on liveliness probing. + format: int64 + type: integer + limit: + description: 'The query limit. ' - location: - $ref: '#/components/schemas/Location' - description: 'The service endpoint label representing a specific location. + format: int32 + type: integer + next_query: + description: 'The limit. ' - name: - description: 'The name of the service endpoint. Max size = 128. + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. ' - type: string - sase_properties: - $ref: '#/components/schemas/SaseServiceEndpointProperties' - description: 'The sase service endpoint properties. + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. ' - service_link_peers: - $ref: '#/components/schemas/ServiceLinkPeers' - description: 'The value of the hostname and IP addresses. + type: boolean + sort_params: + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + ServiceEndpointQueryFilter: + properties: + admin_up: + description: 'All data center sites are automatically added when Admin Up + is selected, which means that it can accept traffic per network policy. + + ' + type: boolean + description: + description: 'The description of the service endpoint. Max size = 256. ' + id: + description: "The ID of the service endpoint.\t\n" + type: string + name: + description: 'The name of the service endpoint. Max size = 128. + + ' + type: string site_id: - description: "The site ID. \n" + description: Site Id type: string tags: description: 'A information field that can be added to identify the service @@ -655,25 +650,34 @@ components: - admin_up - type - name - ServiceLabel: + ServiceEndpointScreen: properties: + admin_up: + description: 'All data center sites are automatically added when Admin Up + is selected, which means that it can accept traffic per network policy. + + ' + type: boolean description: - description: 'The description of the service label. Max size = 256. + description: 'The description of the service endpoint. Max size = 256. ' id: - description: 'The ID of the service label. + description: 'The ID of the service endpoint. ' type: string name: - description: 'The name of the service label. Max size = 128. + description: 'The name of the service endpoint. Max size = 128. ' type: string + site_id: + description: "The site ID. \n" + type: string tags: description: 'A information field that can be added to identify the service - label. Maximum 10 unique tags of length 1024 each are allowed. + endpoint. Maximum 10 unique tags of length 1024 each are allowed. ' items: @@ -690,71 +694,339 @@ components: - SASE type: string required: + - admin_up - type - name - ServiceLabelQuery: + ServiceEndpointV2N1: properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of service labels that match the query - parameters. + address: + $ref: '#/components/schemas/Address' + description: 'The address of the endpoint location. ' - dest_page: - description: 'The destination page. + admin_up: + description: 'All data center sites are automatically added when Admin Up + is selected, which means that it can accept traffic per network policy. + If not selected, the endpoint is not used in path selection for forwarding + traffic. ' - format: int32 - type: integer - getDeleted: - description: 'The number of service labels deleted for a time frame. + type: boolean + allow_enterprise_traffic: + description: 'Explicitly allow enterprise traffic to transit through the + cloud security service. ' type: boolean - group_by: - description: 'Group the service labels for the query. + description: + description: 'The description of the service endpoint. Max size = 256. ' - items: - description: Group By - type: string - type: array id: - description: "Lists the service label by ID. \n" + description: 'The ID of the service endpoint. + + ' type: string - last_query_ts: - description: 'Return the ID of a specified query in the current session. + liveliness_probe: + $ref: '#/components/schemas/SEPLivelinessProbe' + description: 'The information on liveliness probing. ' - format: int64 - type: integer - limit: - description: 'The query limit. + location: + $ref: '#/components/schemas/Location' + description: 'The service endpoint label representing a specific location. ' - format: int32 - type: integer - next_query: - description: 'The limit. + name: + description: 'The name of the service endpoint. Max size = 128. ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. + type: string + service_link_peers: + $ref: '#/components/schemas/ServiceLinkPeers' + description: 'The value of the hostname and IP addresses. + + ' + site_id: + description: "The site ID. \n" + type: string + tags: + description: 'A information field that can be added to identify the service + endpoint. 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: + description: 'The network service type. ' - type: boolean - sort_params: + enum: + - CG_TRANSIT + - NON_CG_TRANSIT + - SASE + type: string + required: + - admin_up + - type + - name + ServiceEndpointV2N2: + properties: + address: + $ref: '#/components/schemas/Address' + description: 'The address of the endpoint location. + + ' + admin_up: + description: 'All data center sites are automatically added when Admin Up + is selected, which means that it can accept traffic per network policy. + If not selected, the endpoint is not used in path selection for forwarding + traffic. + + ' + type: boolean + allow_enterprise_traffic: + description: 'Explicitly allow enterprise traffic to transit through the + cloud security service. + + ' + type: boolean + description: + description: 'The description of the service endpoint. Max size = 256. + + ' + id: + description: 'The ID of the service endpoint. + + ' + type: string + liveliness_probe: + $ref: '#/components/schemas/SEPLivelinessProbeV2N2' + description: 'The information on liveliness probing. + + ' + location: + $ref: '#/components/schemas/Location' + description: 'The service endpoint label representing a specific location. + + ' + name: + description: 'The name of the service endpoint. Max size = 128. + + ' + type: string + service_link_peers: + $ref: '#/components/schemas/ServiceLinkPeers' + description: 'The value of the hostname and IP addresses. + + ' + site_id: + description: "The site ID. \n" + type: string + tags: + description: 'A information field that can be added to identify the service + endpoint. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The network service type. + + ' + enum: + - CG_TRANSIT + - NON_CG_TRANSIT + - SASE + type: string + required: + - admin_up + - type + - name + ServiceEndpointV2N3: + properties: + address: + $ref: '#/components/schemas/Address' + description: 'The address of the endpoint location. + + ' + admin_up: + description: 'All data center sites are automatically added when Admin Up + is selected, which means that it can accept traffic per network policy. + If not selected, the endpoint is not used in path selection for forwarding + traffic. + + ' + type: boolean + allow_enterprise_traffic: + description: 'Explicitly allow enterprise traffic to transit through the + cloud security service. + + ' + type: boolean + description: + description: 'The description of the service endpoint. Max size = 256. + + ' + id: + description: 'The ID of the service endpoint. + + ' + type: string + liveliness_probe: + $ref: '#/components/schemas/SEPLivelinessProbeV2N2' + description: 'The information on liveliness probing. + + ' + location: + $ref: '#/components/schemas/Location' + description: 'The service endpoint label representing a specific location. + + ' + name: + description: 'The name of the service endpoint. Max size = 128. + + ' + type: string + sase_properties: + $ref: '#/components/schemas/SaseServiceEndpointProperties' + description: 'The sase service endpoint properties. + + ' + service_link_peers: + $ref: '#/components/schemas/ServiceLinkPeers' + description: 'The value of the hostname and IP addresses. + + ' + site_id: + description: "The site ID. \n" + type: string + tags: + description: 'A information field that can be added to identify the service + endpoint. Maximum 10 unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'The network service type. + + ' + enum: + - CG_TRANSIT + - NON_CG_TRANSIT + - SASE + type: string + required: + - admin_up + - type + - name + ServiceLabel: + properties: + description: + description: 'The description of the service label. Max size = 256. + + ' + id: + description: 'The ID of the service label. + + ' + type: string + name: + description: 'The name of the service label. Max size = 128. + + ' + type: string + tags: + 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: 'The network service type. + + ' + enum: + - CG_TRANSIT + - NON_CG_TRANSIT + - SASE + type: string + required: + - type + - name + ServiceLabelQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of service labels that match the query + parameters. + + ' + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number of service labels deleted for a time frame. + + ' + type: boolean + group_by: + description: 'Group the service labels for the query. + + ' + items: + description: Group By + type: string + type: array + id: + description: "Lists the service label 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. @@ -915,7 +1187,220 @@ paths: - properties: items: items: - $ref: '#/components/schemas/ServiceBindingMap' + $ref: '#/components/schemas/ServiceBindingMap' + 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 Service Binding Map List (v2.0) + tags: + - Service & DC Groups + post: + description: Create a new service binding map. + operationId: post-sdwan-v2.0-api-servicebindingmaps + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceBindingMapScreen' + description: Details of the service binding maps to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceBindingMap' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + - code: SERVICEBINDINGMAP_CONFIG_INVALID_SERVICEENDPOINT + - code: SERVICEBINDINGMAP_NAME_REQD + - code: DESCRIPTION_SIZE_EXCEEDED + - code: SERVICEBINDING_NAME_EXCEEDS_LIMIT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: SERVICEBINDINGMAP_CONFIG_INVALID_SERVICELABEL + - code: SERVICEBINDINGMAP_CONFIG_SASELABEL_TOO_MANY_SERVICEENDPOINTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Service Binding Map (v2.0) + tags: + - Service & DC Groups + /sdwan/v2.0/api/servicebindingmaps/query: + post: + description: Query the DB for limit number of service binding maps that match + query parameters. + operationId: post-sdwan-v2.0-api-servicebindingmaps-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceBindingMapQuery' + description: Query details for service bindings + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ServiceBindingMap' + 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 Service Binding Maps (v2.0) + tags: + - Service & DC Groups + /sdwan/v2.0/api/servicebindingmaps/{map_id}: + delete: + description: Delete a service binding map. + operationId: delete-sdwan-v2.0-api-servicebindingmaps-map_id + parameters: + - description: The ID of the service binding map. + in: path + name: map_id + required: true + schema: + description: Map Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceBindingMap' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Service Binding Map (v2.0) + tags: + - Service & DC Groups + get: + description: Get a service binding map. + operationId: get-sdwan-v2.0-api-servicebindingmaps-map_id + parameters: + - description: The ID of the service binding map. + in: path + name: map_id + required: true + schema: + description: Map Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceBindingMap' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + - code: SERVICEBINDINGMAP_DELETE_NOTALLOWED_SITE_EXISTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Service Binding Map (v2.0) + tags: + - Service & DC Groups + put: + description: Update a service binding map. + operationId: put-sdwan-v2.0-api-servicebindingmaps-map_id + parameters: + - description: The ID of the service binding map. + in: path + name: map_id + required: true + schema: + description: Map Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceBindingMapScreen' + description: Details of the service binding maps to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceBindingMap' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + - code: SERVICEBINDINGMAP_NAME_REQD + - code: DESCRIPTION_SIZE_EXCEEDED + - code: SERVICEBINDING_NAME_EXCEEDS_LIMIT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: SERVICEBINDINGMAP_CONFIG_INVALID_SERVICELABEL + - code: SERVICEBINDINGMAP_CONFIG_INVALID_SERVICEENDPOINT + - code: SERVICEBINDINGMAP_CONFIG_SASELABEL_TOO_MANY_SERVICEENDPOINTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Service Binding Map (v2.0) + tags: + - Service & DC Groups + /sdwan/v2.0/api/serviceendpoints: + get: + description: List all the servie endpoints. + operationId: get-sdwan-v2.0-api-serviceendpoints + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ServiceEndpoint' type: array type: object description: Successful Operation @@ -929,24 +1414,24 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Service Binding Map List (v2.0) + summary: Get Service Endpoint List (v2.0) tags: - Service & DC Groups post: - description: Create a new service binding map. - operationId: post-sdwan-v2.0-api-servicebindingmaps + description: Create a new service endpoint. + operationId: post-sdwan-v2.0-api-serviceendpoints requestBody: content: application/json: schema: - $ref: '#/components/schemas/ServiceBindingMapScreen' - description: Details of the service binding maps to be created + $ref: '#/components/schemas/ServiceEndpointScreen' + description: Details of the service endpoint to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ServiceBindingMap' + $ref: '#/components/schemas/ServiceEndpoint' description: Successful Operation '400': content: @@ -955,30 +1440,30 @@ paths: value: _error: - code: INVALID_JSON - - code: SERVICEBINDINGMAP_CONFIG_INVALID_SERVICEENDPOINT - - code: SERVICEBINDINGMAP_NAME_REQD + - code: SERVICEENDPOINT_NAME_REQD + - code: SERVICEENDPOINT_NAME_EXCEEDS_LIMIT - code: DESCRIPTION_SIZE_EXCEEDED - - code: SERVICEBINDING_NAME_EXCEEDS_LIMIT + - code: ADMIN_UP_REQD - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: SERVICEBINDINGMAP_CONFIG_INVALID_SERVICELABEL - - code: SERVICEBINDINGMAP_CONFIG_SASELABEL_TOO_MANY_SERVICEENDPOINTS + - code: UNKNOWN_SITE + - code: SERVICEENDPOINT_EXIST_WITH_SITE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Service Binding Map (v2.0) + summary: Create Service Endpoint List (v2.0) tags: - Service & DC Groups - /sdwan/v2.0/api/servicebindingmaps/query: + /sdwan/v2.0/api/serviceendpoints/query: post: - description: Query the DB for limit number of service binding maps that match + description: Query the DB for limit number of service bindings that match the query parameters. - operationId: post-sdwan-v2.0-api-servicebindingmaps-query + operationId: post-sdwan-v2.0-api-serviceendpoints-query requestBody: content: application/json: schema: - $ref: '#/components/schemas/ServiceBindingMapQuery' - description: Query details for service bindings + $ref: '#/components/schemas/ServiceEndpointQuery' + description: Query details for service endpoints responses: '200': content: @@ -989,7 +1474,7 @@ paths: - properties: items: items: - $ref: '#/components/schemas/ServiceBindingMap' + $ref: '#/components/schemas/ServiceEndpointQueryFilter' type: array type: object description: Successful Operation @@ -1003,27 +1488,27 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Service Binding Maps (v2.0) + summary: Query DB for Service Bindings (v2.0) tags: - Service & DC Groups - /sdwan/v2.0/api/servicebindingmaps/{map_id}: + /sdwan/v2.0/api/serviceendpoints/{service_endpoint_id}: delete: - description: Delete a service binding map. - operationId: delete-sdwan-v2.0-api-servicebindingmaps-map_id + description: Delete a service endpoint. + operationId: delete-sdwan-v2.0-api-serviceendpoints-service_endpoint_id parameters: - - description: The ID of the service binding map. + - description: The ID of the service endpoint. in: path - name: map_id + name: service_endpoint_id required: true schema: - description: Map Id + description: Service Endpoint Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ServiceBindingMap' + $ref: '#/components/schemas/ServiceEndpoint' description: Successful Operation '400': content: @@ -1032,29 +1517,30 @@ paths: value: _error: - code: INVALID_JSON + - code: SERVICEENDPOINT_DELETE_NOTALLOWED_SERVICEBINDING_EXISTS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Service Binding Map (v2.0) + summary: Delete Service Endpoint (v2.0) tags: - Service & DC Groups get: - description: Get a service binding map. - operationId: get-sdwan-v2.0-api-servicebindingmaps-map_id + description: List a service endpoint. + operationId: get-sdwan-v2.0-api-serviceendpoints-service_endpoint_id parameters: - - description: The ID of the service binding map. + - description: The ID of the service endpoint. in: path - name: map_id + name: service_endpoint_id required: true schema: - description: Map Id + description: Service Endpoint Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ServiceBindingMap' + $ref: '#/components/schemas/ServiceEndpoint' description: Successful Operation '400': content: @@ -1063,36 +1549,35 @@ paths: value: _error: - code: INVALID_JSON - - code: SERVICEBINDINGMAP_DELETE_NOTALLOWED_SITE_EXISTS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Service Binding Map (v2.0) + summary: Get Service Endpoint (v2.0) tags: - Service & DC Groups put: - description: Update a service binding map. - operationId: put-sdwan-v2.0-api-servicebindingmaps-map_id + description: Update a service endpoint. + operationId: put-sdwan-v2.0-api-serviceendpoints-service_endpoint_id parameters: - - description: The ID of the service binding map. + - description: The ID of the service endpoint. in: path - name: map_id + name: service_endpoint_id required: true schema: - description: Map Id + description: Service Endpoint Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ServiceBindingMapScreen' - description: Details of the service binding maps to be updated + $ref: '#/components/schemas/ServiceEndpointScreen' + description: Details of the service endpoint to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ServiceBindingMap' + $ref: '#/components/schemas/ServiceEndpoint' description: Successful Operation '400': content: @@ -1101,17 +1586,17 @@ paths: value: _error: - code: INVALID_JSON - - code: SERVICEBINDINGMAP_NAME_REQD + - code: SERVICEENDPOINT_NAME_REQD + - code: SERVICEENDPOINT_NAME_EXCEEDS_LIMIT - code: DESCRIPTION_SIZE_EXCEEDED - - code: SERVICEBINDING_NAME_EXCEEDS_LIMIT + - code: ADMIN_UP_REQD - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: SERVICEBINDINGMAP_CONFIG_INVALID_SERVICELABEL - - code: SERVICEBINDINGMAP_CONFIG_INVALID_SERVICEENDPOINT - - code: SERVICEBINDINGMAP_CONFIG_SASELABEL_TOO_MANY_SERVICEENDPOINTS + - code: UNKNOWN_SITE + - code: SERVICEENDPOINT_CONFIG_UPDATE_NOTALLOWED schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Service Binding Map (v2.0) + summary: Update Service Endpoint (v2.0) tags: - Service & DC Groups /sdwan/v2.0/api/servicelabels: @@ -1531,6 +2016,211 @@ paths: summary: Update Service Binding Map (v2.1) tags: - Service & DC Groups + /sdwan/v2.1/api/serviceendpoints: + get: + description: List all the servie endpoints. + operationId: get-sdwan-v2.1-api-serviceendpoints + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ServiceEndpointV2N1' + 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 Service Endpoint List (v2.1) + tags: + - Service & DC Groups + post: + description: Create a new service endpoint. + operationId: post-sdwan-v2.1-api-serviceendpoints + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceEndpointV2N1' + description: Service Endpoint + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceEndpointV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: UNKNOWN_SITE + - code: SERVICEENDPOINT_EXIST_WITH_SITE + - code: INVALID_JSON_EXTRA_ATTRIBUTE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Service Endpoint List (v2.1) + tags: + - Service & DC Groups + /sdwan/v2.1/api/serviceendpoints/query: + post: + description: Query the DB for limit number of service bindings that match the + query parameters. + operationId: post-sdwan-v2.1-api-serviceendpoints-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceEndpointQuery' + description: Query details for Priority Policy set stacks + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ServiceEndpointQueryFilter' + 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 Service Bindings (v2.1) + tags: + - Service & DC Groups + /sdwan/v2.1/api/serviceendpoints/{service_endpoint_id}: + delete: + description: Delete a service endpoint. + operationId: delete-sdwan-v2.1-api-serviceendpoints-service_endpoint_id + parameters: + - description: The ID of the service endpoint. + in: path + name: service_endpoint_id + required: true + schema: + description: Service Endpoint Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceEndpointV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + - code: SERVICEENDPOINT_IS_IN_USE + - code: SERVICEENDPOINT_DELETE_NOTALLOWED_SERVICEBINDING_EXISTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Service Endpoint (v2.1) + tags: + - Service & DC Groups + get: + description: List a service endpoint. + operationId: get-sdwan-v2.1-api-serviceendpoints-service_endpoint_id + parameters: + - description: The ID of the service endpoint. + in: path + name: service_endpoint_id + required: true + schema: + description: Service Endpoint Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceEndpointV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Service Endpoint (v2.1) + tags: + - Service & DC Groups + put: + description: Update a service endpoint. + operationId: put-sdwan-v2.1-api-serviceendpoints-service_endpoint_id + parameters: + - description: The ID of the service endpoint. + in: path + name: service_endpoint_id + required: true + schema: + description: Service Endpoint Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceEndpointV2N1' + description: Service Endpoint + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceEndpointV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: UNKNOWN_SITE + - code: SERVICEENDPOINT_CONFIG_UPDATE_NOTALLOWED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Service Endpoint (v2.1) + tags: + - Service & DC Groups /sdwan/v2.1/api/servicelabels: get: description: List all the service labels. diff --git a/openapi-specs/sdwan/unified/Services.yaml b/openapi-specs/sdwan/unified/Services.yaml index 0208b9878..59114faf7 100644 --- a/openapi-specs/sdwan/unified/Services.yaml +++ b/openapi-specs/sdwan/unified/Services.yaml @@ -32,6 +32,64 @@ components: ' type: string type: object + SyslogServer: + properties: + description: + description: 'The description of the syslog server. Max characters = 1024. + + ' + enabled: + description: 'The Syslog server field is enabled to enable the Syslog server. + + ' + type: boolean + id: + description: 'The ID of the Syslog server. + + ' + type: string + name: + description: 'The Syslog server name. Max characters = 128. + + ' + type: string + protocol: + description: "The protocol type (TCP, or UDP, or TLS). The default protocol\ + \ is UDP. \n" + type: string + server_ip: + description: "The Syslog server IP address. \n" + type: string + server_port: + description: 'The Syslog server port number. The default port is 514 for + TCP or UDP and 6514 for TLS. + + ' + format: int32 + type: integer + severity_level: + description: 'The Severity Level from a severity level of critical, major, + or minor. + + ' + type: string + source_interface: + description: 'The source interface for the Syslog server. If no value is + entered for this field, then the controller port is considered as the + default source interface. + + ' + type: string + tags: + description: "A information field that can be added to identify the event\ + \ multicast RP config. Maximum 10 unique tags of length 1024 each are\ + \ allowed. \n" + items: + description: Tags + type: string + type: array + required: + - name SyslogServerProfile: properties: description: @@ -308,6 +366,225 @@ info: version: Latest openapi: 3.0.0 paths: + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/syslogservers: + get: + description: Get the syslog servers on an element. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-syslogservers + parameters: + - description: ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: 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/SyslogServer' + type: array + type: object + description: Successful Operation + summary: Get Syslog Servers on an Element (v2.0) + tags: + - Services + post: + description: Create a syslog Server. + operationId: post-sdwan-v2.0-api-sites-site_id-elements-element_id-syslogservers + parameters: + - description: ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: 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/SyslogServer' + description: Details of the Syslog Server + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServer' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: ELEMENT_NOT_FOUND + - code: ELEMENT_NOT_BOUND + - code: SYSLOGSERVER_CONFIG_EXCEEDS_LIMIT + - code: SYSLOGSERVER_CONFIG_SERVER_IP_MISSING + - code: SYSLOGSERVER_CONFIG_INVALID_RANGE + - code: SYSLOGSERVER_CONFIG_INVALID_PROTOCOL + - code: SYSLOGSERVER_CONFIG_INVALID_SEVERITY_LEVEL + - code: SYSLOGSERVER_CONFIG_NOT_SUPPORTED + - code: SYSLOGSERVER_CONFIG_FLOW_LOGGING_NOT_SUPPORTED + - code: SYSLOGSERVER_CONFIG_REQD_SOURCE_INTERFACE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Syslog Server (v2.0) + tags: + - Services + /sdwan/v2.0/api/sites/{site_id}/elements/{element_id}/syslogservers/{syslogserver_id}: + delete: + description: Delete the syslog server. + operationId: delete-sdwan-v2.0-api-sites-site_id-elements-element_id-syslogservers-syslogserver_id + parameters: + - description: ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The syslog server configuration ID. + in: path + name: syslogserver_id + required: true + schema: + description: Syslogserver Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServer' + description: Successful Operation + summary: Delete Syslog Server (v2.0) + tags: + - Services + get: + description: List the syslog server. + operationId: get-sdwan-v2.0-api-sites-site_id-elements-element_id-syslogservers-syslogserver_id + parameters: + - description: ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The syslog server configuration ID. + in: path + name: syslogserver_id + required: true + schema: + description: Syslogserver Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServer' + description: Successful Operation + summary: Get Syslog Server (v2.0) + tags: + - Services + put: + description: Update the syslog server. + operationId: put-sdwan-v2.0-api-sites-site_id-elements-element_id-syslogservers-syslogserver_id + parameters: + - description: ID of the site. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: The syslog server configuration ID. + in: path + name: syslogserver_id + required: true + schema: + description: Syslogserver Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServer' + description: Details of the Syslog Server + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServer' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: SYSLOGSERVER_CONFIG_SERVER_IP_MISSING + - code: SYSLOGSERVER_CONFIG_INVALID_RANGE + - code: SYSLOGSERVER_CONFIG_INVALID_PROTOCOL + - code: SYSLOGSERVER_CONFIG_INVALID_SEVERITY_LEVEL + - code: SYSLOGSERVER_CONFIG_FLOW_LOGGING_NOT_SUPPORTED + - code: SYSLOGSERVER_CONFIG_REQD_SOURCE_INTERFACE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Syslog Server (v2.0) + tags: + - Services /sdwan/v2.0/api/syslogserverprofiles: get: description: List the syslog server profiles. diff --git a/openapi-specs/sdwan/unified/SiteConfiguration.yaml b/openapi-specs/sdwan/unified/SiteConfiguration.yaml index 52a7f6698..1b1112081 100644 --- a/openapi-specs/sdwan/unified/SiteConfiguration.yaml +++ b/openapi-specs/sdwan/unified/SiteConfiguration.yaml @@ -46,21 +46,9 @@ components: type: string Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -74,28 +62,42 @@ components: - avg - sum type: string - statistic: - description: 'The aggregate statistics. + 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: string - unit: - description: 'The unit. + type: boolean + suppressed: + description: 'The events are suppressed. True or False. ' - type: string - AggregateData: - properties: - value: - description: 'Value of the aggregate data. + type: boolean + suppressed_info: + $ref: '#/components/schemas/SuppressedInfo' + description: 'The information on the suppressed events. ' - type: number - view: - description: 'View the aggregate date. + timestamp: + description: 'The time stamp of the event. ' - type: object + format: int64 + type: integer BulkResponse: properties: count: @@ -946,7 +948,7 @@ components: ' format: int64 type: integer - SiteQueryFilterV4N8: + SiteQueryFilter: properties: address: $ref: '#/components/schemas/Address' @@ -970,12 +972,10 @@ 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" + events: + description: Events items: - $ref: '#/components/schemas/ExtendedTag' + $ref: '#/components/schemas/BaseEventState' type: array id: description: 'The ID. @@ -987,73 +987,93 @@ components: description: 'The geographical cordinates for the site address. ' - multicast_peer_group_id: - description: 'The multicast peer group ID. + name: + description: 'The site name (Max size = 128). ' type: string - name: - description: 'The site name (Max size = 128). + policy_set_id: + description: 'The ID for the Original Network Policy Set. Can be retrieved + using policysets API. ' type: string - nat_policysetstack_id: - description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack - API. + security_policyset_id: + description: 'The ID for the Original Security Policy Set. Can be retrieved + using securitypolicysets API. ' type: string - network_policysetstack_id: - description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps API. ' type: string - policy_set_id: - description: 'The ID for the Original Network Policy Set. Can be retrieved - using policysets API. + SiteQueryFilterV4N2: + 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 - priority_policysetstack_id: - description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack - API. + 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 - security_policyset_id: - description: Security Policyset Id + id: + description: 'The ID. + + ' type: string - security_policysetstack_id: - description: 'ID for the Security Policyset Stack. Can be retrieved using - ngfwpolicysetstack API. + location: + $ref: '#/components/schemas/Location' + description: 'The geographical cordinates for the site address. + + ' + name: + description: 'The site name (Max size = 128). ' type: string - service_binding: - description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps - API. + network_policysetstack_id: + description: Network Policysetstack Id + type: string + policy_set_id: + description: 'The ID for the Original Network Policy Set. Can be retrieved + using policysets API. ' type: string - tags: - description: 'A information field that can be added to identify the site. + priority_policysetstack_id: + description: Priority Policysetstack Id + type: string + security_policyset_id: + description: 'The ID for the Original Security Policy Set. Can be retrieved + using securitypolicysets API. ' - items: - description: Tags - type: string - type: array - vrf_context_profile_id: - description: 'The VRF (Virtual Routing and Forwarding) profile ID. + type: string + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps + API. ' type: string - required: - - element_cluster_role - - admin_state - - name - SiteQueryFilterV4N9: + SiteQueryFilterV4N3: properties: address: $ref: '#/components/schemas/Address' @@ -1077,15 +1097,6 @@ 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. @@ -1096,31 +1107,17 @@ 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: '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. + description: 'The 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. @@ -1137,12 +1134,6 @@ 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: @@ -1159,16 +1150,7 @@ 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 - SiteScreenV4N8: + SiteQueryFilterV4N4: properties: address: $ref: '#/components/schemas/Address' @@ -1192,13 +1174,6 @@ 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. @@ -1209,25 +1184,17 @@ 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: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack - API. - - ' + description: Nat Policysetstack Id type: string network_policysetstack_id: - description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack - API. + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. ' type: string @@ -1244,11 +1211,8 @@ 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. + description: 'The ID for the Original Security Policy Set. Can be retrieved + using securitypolicysets API. ' type: string @@ -1266,16 +1230,7 @@ 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 - SiteScreenV4N9: + SiteQueryFilterV4N5: properties: address: $ref: '#/components/schemas/Address' @@ -1300,11 +1255,9 @@ 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. - - ' + description: 'Extended Tags: Valid ListObject(allowDuplicate = false, allowEmpty + = true, allowNull = true, listMaxSize = 10, message = INVALID_EXTENDED_TAG_SIZE_OR_DUPLICATE, + required = false) ' items: $ref: '#/components/schemas/ExtendedTag' type: array @@ -1318,11 +1271,6 @@ 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). @@ -1335,14 +1283,11 @@ components: ' type: string network_policysetstack_id: - description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack - API. + description: 'The 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. @@ -1359,12 +1304,6 @@ 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: @@ -1381,11 +1320,6 @@ 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 @@ -1436,7 +1370,7 @@ components: type: string required: - site_id - SiteV4N8: + SiteV4N2: properties: address: $ref: '#/components/schemas/Address' @@ -1460,15 +1394,6 @@ 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. @@ -1479,31 +1404,20 @@ 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: '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. + description: 'The 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. + using policy sets API. ' type: string @@ -1515,13 +1429,7 @@ components: 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. + using security policy sets API. ' type: string @@ -1529,26 +1437,13 @@ components: 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 - SiteV4N9: + SiteV4N3: properties: address: $ref: '#/components/schemas/Address' @@ -1572,15 +1467,6 @@ 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. @@ -1591,31 +1477,17 @@ components: description: 'The geographical cordinates for the site address. ' - multicast_peer_group_id: - description: 'The multicast peer group ID. + name: + description: 'The site name (Max size = 128). ' type: string - name: - description: 'The site name (Max size = 128). + network_policysetstack_id: + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. ' 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. @@ -1632,12 +1504,6 @@ 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: @@ -1654,44 +1520,85 @@ 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 - SpokeCluster: + SiteV4N4: properties: - advertisement_interval: - description: "Lists the intervals in which the active device advertises\ - \ its status to the backup. \n" - format: double - type: number + 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: 'The cluster 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 id: - description: 'The ID of the site. + description: 'The ID. ' type: string + location: + $ref: '#/components/schemas/Location' + description: 'The geographical cordinates for the site address. + + ' name: - description: 'Name of the cluster. + description: 'The site name (Max size = 128). ' type: string - preempt: - description: 'Indicates if preemption is required or not. + nat_policysetstack_id: + description: 'Nat Policysetstack Id: Digits(fraction = 0, integer = 20, + error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) ' + type: string + network_policysetstack_id: + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. ' - type: boolean + 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 + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps + API. + + ' + type: string tags: - description: 'Displays the details about the tags or labels applied to the - clusters. + description: 'A information field that can be added to identify the site. ' items: @@ -1699,117 +1606,93 @@ components: type: string type: array required: - - advertisement_interval - - preempt + - element_cluster_role + - admin_state - name - SpokeClusterOperations: + SiteV4N5: properties: - action: - description: "Lists the action to be performed on the cluster. \n" - enum: - - RE_ELECTION - type: string - id: - description: 'The ID of the spoke cluster. + address: + $ref: '#/components/schemas/Address' + description: 'The address of the site. ' - type: string - SpokeClusterQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of clusters that match the query parameters. + 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. ' - dest_page: - description: 'The destination page. + type: string + description: + description: 'Description for the site (Max size = 1024). ' - format: int32 - type: integer - getDeleted: - description: 'The number clusters deleted for a time frame. + element_cluster_role: + description: 'This attribute describes the type i.e. SPOKE or HUB. ' - type: boolean - group_by: - description: Group By + 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) ' items: - description: Group By - type: string + $ref: '#/components/schemas/ExtendedTag' type: array id: - description: "List the clusters 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. + description: 'The ID. ' - format: int32 - type: integer - next_query: - description: 'The limit. + type: string + location: + $ref: '#/components/schemas/Location' + description: 'The geographical cordinates for the site address. ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. + name: + description: 'The site name (Max size = 128). ' - items: - description: Retrieved Fields - type: string - type: array - retrieved_fields_mask: - description: 'List the fields to query. + type: string + nat_policysetstack_id: + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. ' - type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. + type: string + network_policysetstack_id: + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. ' - format: int64 - type: integer - SpokeClusterQueryFilter: - properties: - advertisement_interval: - description: "Lists the intervals in which the active device advertises\ - \ its status to the backup. \n" - format: double - type: number - description: - description: 'The cluster description. + type: string + policy_set_id: + description: 'The ID for the Original Network Policy Set. Can be retrieved + using policysets API. ' - id: - description: 'The ID of the site. + type: string + priority_policysetstack_id: + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. ' type: string - name: - description: 'Name of the cluster. + security_policyset_id: + description: 'The ID for the Original Security Policy Set. Can be retrieved + using securitypolicysets API. ' type: string - preempt: - description: 'Indicates if preemption is required or not. + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps + API. ' - type: boolean + type: string tags: - description: 'Displays the details about the tags or labels applied to the - clusters. + description: 'A information field that can be added to identify the site. ' items: @@ -1817,432 +1700,504 @@ components: type: string type: array required: - - advertisement_interval - - preempt + - element_cluster_role + - admin_state - name - SpokeClusterQueryFilterResponse: + SiteV4N6: properties: - advertisement_interval: - description: "List the intervals in which the active device advertises its\ - \ status to the backup. \n" - format: double - type: number - description: - description: 'The cluster description. + address: + $ref: '#/components/schemas/Address' + description: 'The address of the site. ' - id: - description: 'The ID 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 - name: - description: 'Name of the cluster. + description: + description: 'Description for the site (Max size = 1024). ' - type: string - preempt: - description: 'Indicates if preemption is required or not. + element_cluster_role: + description: 'This attribute describes the type i.e. SPOKE or HUB. ' - type: boolean - site_id: - description: Site Id type: string - tags: - description: 'Displays the details about the tags or labels applied to the - clusters. + 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: - description: Tags - type: string - type: array - SpokeClusterStatus: - properties: - cluster_members: - description: "Lists the members of the spoke cluster. \n" - items: - $ref: '#/components/schemas/ClusterMember' + $ref: '#/components/schemas/ExtendedTag' type: array id: - description: 'The ID of the spoke cluster. - - ' - type: string - switch_over_events: - description: 'List the spoke cluster switch over event history. + description: 'The ID. ' - items: - $ref: '#/components/schemas/SwitchOverEvent' - type: array - SwitchOverEvent: - properties: - active: - description: Active - type: boolean - adjustments: - description: Adjustments - items: - $ref: '#/components/schemas/Adjustment' - type: array - cluster_events: - description: Cluster Events - items: - $ref: '#/components/schemas/ClusterEvent' - type: array - effective_priority: - description: Effective Priority - format: int32 - type: integer - element_id: - description: Element Id type: string - peer_connected: - description: Peer Connected - type: boolean - switch_over_time: - description: Switch Over Time - format: int64 - type: integer - ThresholdConfig: - properties: - critical_alarm: - description: Critical Alarm - format: int32 - type: integer - major_alarm: - description: Major Alarm - format: int32 - type: integer - subscription_factor: - description: Subscription Factor - format: double - type: number - VPNLinkConfiguration: - properties: - keep_alive_failure_count: - description: 'The VPN keep alive failure count (must be between 3 and 30). + location: + $ref: '#/components/schemas/Location' + description: 'The geographical cordinates for the site address. ' - type: integer - keep_alive_interval: - description: 'The VPN keep alive timeout interval (must be between 100ms-1740,000ms). + name: + description: 'The site name (Max size = 128). ' - type: integer - required: - - keep_alive_failure_count - - keep_alive_interval - WANInterfaceQuery: - properties: - aggregate: - $ref: '#/components/schemas/Aggregate' - description: 'The aggregate number of app defs that match the query parameters. + type: string + nat_policysetstack_id: + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. ' - dest_page: - description: 'The destination page. + type: string + network_policysetstack_id: + description: 'The ID for the Path Policyset Stack. Can be retrieved using + networkpolicysetstack API. ' - format: int32 - type: integer - getDeleted: - description: 'The number app definitions deleted for a time frame. + type: string + policy_set_id: + description: 'The ID for the Original Network Policy Set. Can be retrieved + using policysets API. ' - 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. + priority_policysetstack_id: + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. ' - format: int64 - type: integer - limit: - description: 'The query limit. + type: string + security_policyset_id: + description: 'The ID for the Original Security Policy Set. Can be retrieved + using securitypolicysets API. ' - format: int32 - type: integer - next_query: - description: 'The limit. + type: string + security_policysetstack_id: + description: Security Policysetstack Id + type: string + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps + API. ' - type: object - query_params: - type: object - retrieved_fields: - description: 'Retrieve information from a field. + type: string + tags: + description: 'A information field that can be added to identify the site. ' items: - description: Retrieved Fields + description: Tags type: string type: array - retrieved_fields_mask: - description: 'List the fields to query. + required: + - element_cluster_role + - admin_state + - name + SiteV4N7: + properties: + address: + $ref: '#/components/schemas/Address' + description: 'The address of the site. ' - type: boolean - sort_params: - type: object - total_count: - description: 'The total number of query parameters. + 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 - WANInterfaceQueryFilterV2N7: - properties: - bfd_mode: - 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. + type: string + description: + description: 'Description for the site (Max size = 1024). ' - enum: - - aggressive - - non_aggressive - type: string - bw_config_mode: - description: 'The bandwidth config mode. + element_cluster_role: + description: 'This attribute describes the type i.e. SPOKE or HUB. ' - enum: - - auto - - manual - - manual_bwm_disabled type: string - bwc_enabled: - description: 'The bwc parameters. + 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. ' - type: boolean - cost: - description: 'Cost value for the site WAN interface should be within range - 0-1024. + items: + $ref: '#/components/schemas/ExtendedTag' + type: array + id: + description: 'The ID. ' - type: integer - description: - description: 'The description of the WAN interface config. + type: string + location: + $ref: '#/components/schemas/Location' + description: 'The geographical cordinates for the site address. ' - id: - description: 'The ID. + multicast_peer_group_id: + description: 'The multicast peer group ID. ' type: string - label_id: - description: 'The WAN interface label or Circuit label ID. This can be retrieved - using the waninterfacelabels API. + name: + description: 'The site name (Max size = 128). ' type: string - link_bw_down: - description: 'The circuit downstream capacity in MB. + nat_policysetstack_id: + description: 'ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack + API. ' - format: double - type: number - link_bw_up: - description: 'The circuit upstream capacity in MB. + type: string + network_policysetstack_id: + description: 'ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack + API. ' - format: double - type: number - lqm_config: - $ref: '#/components/schemas/LQMConfig' - description: 'The link quality monitoring parameters. + type: string + policy_set_id: + description: 'The ID for the Original Network Policy Set. Can be retrieved + using policysets API. ' - lqm_enabled: - description: 'The link quality monitoring parameters. + type: string + priority_policysetstack_id: + description: 'ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack + API. ' - type: boolean - name: - description: 'The name of the WAN interface config. + type: string + security_policyset_id: + description: 'The ID for the Original Security Policy Set. Can be retrieved + using securitypolicysets API. ' type: string - network_id: - description: 'The network ID. + security_policysetstack_id: + description: 'ID for the Security Policyset Stack. Can be retrieved using + ngfwpolicysetstack API. ' type: string - site_id: - description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) - NotNull ' + service_binding: + description: 'Bind a site to a set of domains. Can be retrieved using sericebindingmaps + API. + + ' type: string tags: - description: "An information field that can be added to identify the WAN\ - \ interface. Maximum 10 unique tags of length 1024 each are allowed. \ - \ \n" + description: 'A information field that can be added to identify the site. + + ' items: description: Tags type: string type: array - type: - description: 'WAN type. + required: + - element_cluster_role + - admin_state + - name + SpokeCluster: + properties: + advertisement_interval: + description: "Lists the intervals in which the active device advertises\ + \ its status to the backup. \n" + format: double + type: number + description: + description: 'The cluster description. + + ' + id: + description: 'The ID of the site. ' - enum: - - PUBLIC_WAN - - PRIVATE_WAN type: string - use_for_application_reachability_probes: - description: 'Indicates if the use for application reachability probe is - selected. True or False. + name: + description: 'Name of the cluster. ' - type: boolean - use_for_controller_connections: - description: 'Indicates if the use for controller connections is selected. - True or False. + type: string + preempt: + description: 'Indicates if preemption is required or not. ' type: boolean - use_lqm_for_non_hub_paths: - description: Use Lqm For Non Hub Paths - type: boolean - vpnlink_configuration: - $ref: '#/components/schemas/VPNLinkConfiguration' - description: 'Vpnlink Configuration: Valid Nullable ' + tags: + description: 'Displays the details about the tags or labels applied to the + clusters. + + ' + items: + description: Tags + type: string + type: array required: - - site_id - - label_id - - bfd_mode - - bw_config_mode - - network_id - WANInterfaceScreenV2N6: + - advertisement_interval + - preempt + - name + SpokeClusterOperations: properties: - bfd_mode: - 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. + action: + description: "Lists the action to be performed on the cluster. \n" + enum: + - RE_ELECTION + type: string + id: + description: 'The ID of the spoke cluster. ' - enum: - - aggressive - - non_aggressive type: string - bw_config_mode: - description: 'The bandwidth config mode. + SpokeClusterQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of clusters that match the query parameters. ' - enum: - - auto - - manual - - manual_bwm_disabled + dest_page: + description: 'The destination page. + + ' + format: int32 + type: integer + getDeleted: + description: 'The number clusters deleted for a time frame. + + ' + type: boolean + group_by: + description: Group By + items: + description: Group By + type: string + type: array + id: + description: "List the clusters by ID. \n" type: string - bwc_enabled: - description: Bwc Enabled + 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 - cost: - description: 'Cost value for the site WAN interface should be within range - 0-1024. + sort_params: + type: object + total_count: + description: 'The total number of query parameters. ' + format: int64 type: integer + SpokeClusterQueryFilter: + properties: + advertisement_interval: + description: "Lists the intervals in which the active device advertises\ + \ its status to the backup. \n" + format: double + type: number description: - description: 'The description of the WAN interface config (size max = 256). + description: 'The cluster description. ' id: - description: 'The ID. + description: 'The ID of the site. ' type: string - label_id: - description: 'The WAN interface label or Circuit label ID. This can be retrieved - using the waninterfacelabels API. + name: + description: 'Name of the cluster. ' type: string - link_bw_down: - description: 'The circuit downstream capacity in MB. + preempt: + description: 'Indicates if preemption is required or not. ' - format: double - type: number - link_bw_up: - description: 'The circuit upstream capacity in MB. + type: boolean + tags: + description: 'Displays the details about the tags or labels applied to the + clusters. ' + items: + description: Tags + type: string + type: array + required: + - advertisement_interval + - preempt + - name + SpokeClusterQueryFilterResponse: + properties: + advertisement_interval: + description: "List the intervals in which the active device advertises its\ + \ status to the backup. \n" format: double type: number - lqm_config: - $ref: '#/components/schemas/LQMConfig' - description: 'The link quality monitoring parameters. + description: + description: 'The cluster description. ' - lqm_enabled: - description: 'The link quality monitoring parameters. + id: + description: 'The ID of the site. ' - type: boolean + type: string name: - description: 'The name of the WAN interface config (size max = 128). + description: 'Name of the cluster. ' type: string - network_id: - description: 'The network ID. + preempt: + description: 'Indicates if preemption is required or not. ' + type: boolean + site_id: + description: Site Id type: string tags: - description: 'An information field that can be added to identify the application. - Maximum 10 Unique tags of length 1024 each are allowed. + description: 'Displays the details about the tags or labels applied to the + clusters. ' items: description: Tags type: string type: array - type: - description: 'Type of WAN. + SpokeClusterStatus: + properties: + cluster_members: + description: "Lists the members of the spoke cluster. \n" + items: + $ref: '#/components/schemas/ClusterMember' + type: array + id: + description: 'The ID of the spoke cluster. ' - enum: - - PUBLIC_WAN - - PRIVATE_WAN type: string - use_for_application_reachability_probes: - description: 'Indicates if the use for application reachability probe is - selected. - - ' - type: boolean - use_for_controller_connections: - description: 'Indicates if the use for controller connections is selected. + switch_over_events: + description: 'List the spoke cluster switch over event history. ' - type: boolean - vpnlink_configuration: - $ref: '#/components/schemas/VPNLinkConfiguration' - description: 'The configuration of the VPN link. + items: + $ref: '#/components/schemas/SwitchOverEvent' + type: array + 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 + SwitchOverEvent: + properties: + active: + description: Active + type: boolean + adjustments: + description: Adjustments + items: + $ref: '#/components/schemas/Adjustment' + type: array + cluster_events: + description: Cluster Events + items: + $ref: '#/components/schemas/ClusterEvent' + type: array + effective_priority: + description: Effective Priority + format: int32 + type: integer + element_id: + description: Element Id + type: string + peer_connected: + description: Peer Connected + type: boolean + switch_over_time: + description: Switch Over Time + format: int64 + type: integer + ThresholdConfig: + properties: + critical_alarm: + description: Critical Alarm + format: int32 + type: integer + major_alarm: + description: Major Alarm + format: int32 + type: integer + subscription_factor: + description: Subscription Factor + format: double + type: number + 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: - - label_id - - bfd_mode - - bw_config_mode - - network_id - WANInterfaceScreenV2N7: + - keep_alive_failure_count + - keep_alive_interval + WANInterface: properties: bfd_mode: description: 'Allowed values: aggressive - For fast failure detection of @@ -2267,14 +2222,8 @@ components: bwc_enabled: description: Bwc Enabled type: boolean - cost: - description: 'Cost value for the site WAN interface should be within range - 0-1024. - - ' - type: integer description: - description: 'The description of the WAN interface config (size max = 256). + description: 'The description of the WAN interface config. ' id: @@ -2300,18 +2249,13 @@ components: ' format: double type: number - lqm_config: - $ref: '#/components/schemas/LQMConfig' - description: 'The link quality monitoring parameters. - - ' lqm_enabled: description: 'The link quality monitoring parameters. ' type: boolean name: - description: 'The name of the WAN interface config (size max = 128). + description: 'The name of the WAN interface config. ' type: string @@ -2320,62 +2264,79 @@ components: ' type: string - tags: - description: 'An information field that can be added to identify the application. - Maximum 10 Unique tags of length 1024 each are allowed. + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceQuery: + properties: + aggregate: + $ref: '#/components/schemas/Aggregate' + description: 'The aggregate number of app defs that match the query parameters. ' - items: - description: Tags - type: string - type: array - type: - description: 'Type of WAN. + dest_page: + description: 'The destination page. ' - enum: - - PUBLIC_WAN - - PRIVATE_WAN - type: string - use_for_application_reachability_probes: - description: 'Indicates if the use for application reachability probe is - selected. + format: int32 + type: integer + getDeleted: + description: 'The number app definitions deleted for a time frame. ' type: boolean - use_for_controller_connections: - description: 'Indicates if the use for controller connections is selected. + 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. ' - type: boolean - use_lqm_for_non_hub_paths: - description: 'Indicates if the use for lqm for non hub paths is enabled. + format: int64 + type: integer + limit: + description: 'The query limit. ' - type: boolean - vpnlink_configuration: - $ref: '#/components/schemas/VPNLinkConfiguration' - description: 'The configuration of the VPN link. + format: int32 + type: integer + next_query: + description: 'The limit. ' - required: - - label_id - - bfd_mode - - bw_config_mode - - network_id - WANInterfaceState: - properties: - id: - description: 'The ID of the WAN interface. + type: object + query_params: + type: object + retrieved_fields: + description: 'Retrieve information from a field. ' - type: string - operational_state: - description: 'The operational state of the site WAN interface. + items: + description: Retrieved Fields + type: string + type: array + retrieved_fields_mask: + description: 'List the fields to query. ' type: boolean - WANInterfaceV2N6: + sort_params: + type: object + total_count: + description: 'The total number of query parameters. + + ' + format: int64 + type: integer + WANInterfaceQueryFilterV2N7: properties: bfd_mode: description: 'Allowed values: aggressive - For fast failure detection of @@ -2398,7 +2359,9 @@ components: - manual_bwm_disabled type: string bwc_enabled: - description: Bwc Enabled + description: 'The bwc parameters. + + ' type: boolean cost: description: 'Cost value for the site WAN interface should be within range @@ -2407,7 +2370,7 @@ components: ' type: integer description: - description: 'The description of the WAN interface config (size max = 256). + description: 'The description of the WAN interface config. ' id: @@ -2444,7 +2407,7 @@ components: ' type: boolean name: - description: 'The name of the WAN interface config (size max = 128). + description: 'The name of the WAN interface config. ' type: string @@ -2453,17 +2416,20 @@ components: ' type: string + site_id: + description: 'Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) + NotNull ' + type: string tags: - description: 'An information field that can be added to identify the application. - Maximum 10 Unique tags of length 1024 each are allowed. - - ' + 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 of WAN. + description: 'WAN type. ' enum: @@ -2472,25 +2438,29 @@ components: type: string use_for_application_reachability_probes: description: 'Indicates if the use for application reachability probe is - selected. + selected. True or False. ' type: boolean use_for_controller_connections: - description: "Indicates if the use for controller connections is selected.\ - \ \n" + description: 'Indicates if the use for controller connections is selected. + True or False. + + ' + type: boolean + use_lqm_for_non_hub_paths: + description: Use Lqm For Non Hub Paths type: boolean vpnlink_configuration: $ref: '#/components/schemas/VPNLinkConfiguration' - description: 'The configuration of the VPN link. - - ' + description: 'Vpnlink Configuration: Valid Nullable ' required: + - site_id - label_id - bfd_mode - bw_config_mode - network_id - WANInterfaceV2N7: + WANInterfaceScreen: properties: bfd_mode: description: 'Allowed values: aggressive - For fast failure detection of @@ -2515,14 +2485,8 @@ components: bwc_enabled: description: Bwc Enabled type: boolean - cost: - description: 'Cost value for the site WAN interface should be within range - 0-1024. - - ' - type: integer description: - description: 'The description of the WAN interface config (size max = 256). + description: 'The description of the WAN interface config. ' id: @@ -2548,18 +2512,13 @@ components: ' format: double type: number - lqm_config: - $ref: '#/components/schemas/LQMConfig' - description: 'The link quality monitoring parameters. - - ' lqm_enabled: description: 'The link quality monitoring parameters. ' type: boolean name: - description: 'The name of the WAN interface config (size max = 128). + description: 'The name of the WAN interface config. ' type: string @@ -2568,95 +2527,3238 @@ components: ' type: string - tags: - description: 'An information field that can be added to identify the application. - Maximum 10 Unique tags of length 1024 each are allowed. + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceScreenV2N2: + properties: + bfd_mode: + 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. ' - items: - description: Tags - type: string - type: array - type: - description: 'Type of WAN. + enum: + - aggressive + - non_aggressive + type: string + bw_config_mode: + description: 'The bandwidth config mode. ' enum: - - PUBLIC_WAN + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceScreenV2N3: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceScreenV2N4: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_config: + $ref: '#/components/schemas/LQMConfig' + description: 'The link quality monitoring parameters. + + ' + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceScreenV2N5: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_config: + $ref: '#/components/schemas/LQMConfig' + description: 'The link quality monitoring parameters. + + ' + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: Type + enum: + - PUBLIC_WAN + - PRIVATE_WAN + type: string + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceScreenV2N6: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_config: + $ref: '#/components/schemas/LQMConfig' + description: 'The link quality monitoring parameters. + + ' + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'Type of WAN. + + ' + enum: + - PUBLIC_WAN + - PRIVATE_WAN + type: string + use_for_application_reachability_probes: + description: 'Indicates if the use for application reachability probe is + selected. + + ' + type: boolean + use_for_controller_connections: + description: 'Indicates if the use for controller connections is selected. + + ' + type: boolean + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceScreenV2N7: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_config: + $ref: '#/components/schemas/LQMConfig' + description: 'The link quality monitoring parameters. + + ' + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'Type of WAN. + + ' + enum: + - PUBLIC_WAN + - PRIVATE_WAN + type: string + use_for_application_reachability_probes: + description: 'Indicates if the use for application reachability probe is + selected. + + ' + type: boolean + use_for_controller_connections: + description: 'Indicates if the use for controller connections is selected. + + ' + type: boolean + use_lqm_for_non_hub_paths: + description: 'Indicates if the use for lqm for non hub paths is enabled. + + ' + type: boolean + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceState: + properties: + id: + description: 'The ID of the WAN interface. + + ' + type: string + operational_state: + description: 'The operational state of the site WAN interface. + + ' + type: boolean + WANInterfaceV2N2: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + required: + - bfd_mode + WANInterfaceV2N3: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config. + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config. + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - bfd_mode + WANInterfaceV2N4: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_config: + $ref: '#/components/schemas/LQMConfig' + description: 'The link quality monitoring parameters. + + ' + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + required: + - bfd_mode + WANInterfaceV2N5: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_config: + $ref: '#/components/schemas/LQMConfig' + description: 'The link quality monitoring parameters. + + ' + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: Type + enum: + - PUBLIC_WAN + - PRIVATE_WAN + type: string + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'Vpnlink Configuration: Valid ' + required: + - bfd_mode + WANInterfaceV2N6: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_config: + $ref: '#/components/schemas/LQMConfig' + description: 'The link quality monitoring parameters. + + ' + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'Type of WAN. + + ' + enum: + - PUBLIC_WAN + - PRIVATE_WAN + type: string + use_for_application_reachability_probes: + description: 'Indicates if the use for application reachability probe is + selected. + + ' + type: boolean + use_for_controller_connections: + description: "Indicates if the use for controller connections is selected.\ + \ \n" + type: boolean + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id + WANInterfaceV2N7: + properties: + bfd_mode: + 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: 'The bandwidth config mode. + + ' + enum: + - auto + - manual + - manual_bwm_disabled + type: string + bwc_enabled: + description: Bwc Enabled + type: boolean + cost: + description: 'Cost value for the site WAN interface should be within range + 0-1024. + + ' + type: integer + description: + description: 'The description of the WAN interface config (size max = 256). + + ' + id: + description: 'The ID. + + ' + type: string + label_id: + description: 'The WAN interface label or Circuit label ID. This can be retrieved + using the waninterfacelabels API. + + ' + type: string + link_bw_down: + description: 'The circuit downstream capacity in MB. + + ' + format: double + type: number + link_bw_up: + description: 'The circuit upstream capacity in MB. + + ' + format: double + type: number + lqm_config: + $ref: '#/components/schemas/LQMConfig' + description: 'The link quality monitoring parameters. + + ' + lqm_enabled: + description: 'The link quality monitoring parameters. + + ' + type: boolean + name: + description: 'The name of the WAN interface config (size max = 128). + + ' + type: string + network_id: + description: 'The network ID. + + ' + type: string + tags: + description: 'An information field that can be added to identify the application. + Maximum 10 Unique tags of length 1024 each are allowed. + + ' + items: + description: Tags + type: string + type: array + type: + description: 'Type of WAN. + + ' + enum: + - PUBLIC_WAN - PRIVATE_WAN type: string - use_for_application_reachability_probes: - description: 'Indicates if the use for application reachability probe is - selected. - - ' - type: boolean - use_for_controller_connections: - description: "Indicates if the use for controller connections is selected.\ - \ \n" - type: boolean - use_lqm_for_non_hub_paths: - description: Use Lqm For Non Hub Paths - type: boolean - vpnlink_configuration: - $ref: '#/components/schemas/VPNLinkConfiguration' - description: 'The configuration of the VPN link. - - ' - required: - - label_id - - bfd_mode - - bw_config_mode - - network_id -info: - contact: {} - description: List of APIs used to manage your site specific configuration attributes, - and HA configuration for both branch and data center sites. - title: Site Configuration - version: Latest -openapi: 3.0.0 -paths: - /sdwan/v2.0/api/hubserviceendpoints: + use_for_application_reachability_probes: + description: 'Indicates if the use for application reachability probe is + selected. + + ' + type: boolean + use_for_controller_connections: + description: "Indicates if the use for controller connections is selected.\ + \ \n" + type: boolean + use_lqm_for_non_hub_paths: + description: Use Lqm For Non Hub Paths + type: boolean + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'The configuration of the VPN link. + + ' + required: + - label_id + - bfd_mode + - bw_config_mode + - network_id +info: + contact: {} + description: List of APIs used to manage your site specific configuration attributes, + and HA configuration for both branch and data center sites. + title: Site Configuration + version: Latest +openapi: 3.0.0 +paths: + /sdwan/v2.0/api/hubserviceendpoints: + get: + description: Get the hub service endpoints of the tenant. + operationId: get-sdwan-v2.0-api-hubserviceendpoints + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/HubServiceEndpointConfig' + type: array + type: object + description: Successful Operation + summary: Get Hub Service Endpoints of Tenant (v2.0) + tags: + - Site Configuration + /sdwan/v2.0/api/sites/{site_id}/hubserviceendpoints: + get: + description: Get the hub service endpoint for a site of a given tenant using + the tenant ID and site ID. + operationId: get-sdwan-v2.0-api-sites-site_id-hubserviceendpoints + parameters: + - description: ID of the remote site. More details on the site can be retrieved + by querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HubServiceEndpointConfig' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SITE_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get HubServiceEndpoint for Site of a Tenant (v2.0) + tags: + - Site Configuration + /sdwan/v2.0/api/sites/{site_id}/siteciphers: + get: + description: List the ciphers for a particular site. + operationId: get-sdwan-v2.0-api-sites-site_id-siteciphers + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + 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/SiteCipher' + type: array + type: object + description: Successful Operation + summary: Get Site Ciphers (v2.0) + tags: + - Site Configuration + put: + description: Update the ciphers for a particular site. + operationId: put-sdwan-v2.0-api-sites-site_id-siteciphers + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteCipherScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SiteCipher' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Site Cipher (v2.0) + tags: + - Site Configuration + /sdwan/v2.0/api/sites/{site_id}/spokeclusters: + get: + description: List all the spoke clusters for a particular site. + operationId: get-sdwan-v2.0-api-sites-site_id-spokeclusters + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SpokeCluster' + type: array + type: object + description: Successful Operation + summary: Get Spoke Clusters (v2.0) + tags: + - Site Configuration + post: + description: Create cluster to determine which data center communicates with + which branch devices. + operationId: post-sdwan-v2.0-api-sites-site_id-spokeclusters + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeCluster' + description: Details of the spokecluster to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeCluster' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: SPOKECLUSTER_CONFIG_INVALID_SITE + - code: SPOKECLUSTER_CONFIG_EXCEEDS_LIMIT + - code: ADVERTISEMENT_INTERVAL_INVALID_DECIMAL + - code: ADVERTISEMENT_INTERVAL_REQD + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Spoke Cluster (v2.0) + tags: + - Site Configuration + /sdwan/v2.0/api/sites/{site_id}/spokeclusters/query: + post: + description: Query the spoke clusters for a site. + operationId: post-sdwan-v2.0-api-sites-site_id-spokeclusters-query + parameters: + - description: The site ID for which you wish to query the spoke clusters. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeClusterQuery' + description: Query Details for the spokecluster + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SpokeClusterQueryFilter' + 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 Spoke Clusters (v2.0) + tags: + - Site Configuration + /sdwan/v2.0/api/sites/{site_id}/spokeclusters/{spoke_cluster_id}: + delete: + description: Delete a spoke cluster. + operationId: delete-sdwan-v2.0-api-sites-site_id-spokeclusters-spoke_cluster_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the spoke cluster. + in: path + name: spoke_cluster_id + required: true + schema: + description: Spoke Cluster Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeCluster' + description: Successful Operation + summary: Delete Spoke Cluster (v2.0) + tags: + - Site Configuration + get: + description: Get all the details of the spoke cluster. + operationId: get-sdwan-v2.0-api-sites-site_id-spokeclusters-spoke_cluster_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the spoke cluster. + in: path + name: spoke_cluster_id + required: true + schema: + description: Spoke Cluster Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeCluster' + description: Successful Operation + summary: Get Spoke Cluster Details (v2.0) + tags: + - Site Configuration + put: + description: Details of the spoke cluster that needs to be modified. + operationId: put-sdwan-v2.0-api-sites-site_id-spokeclusters-spoke_cluster_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the spoke cluster. + in: path + name: spoke_cluster_id + required: true + schema: + description: Spoke Cluster Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeCluster' + description: Details of the spokecluster to be modified + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeCluster' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: ADVERTISEMENT_INTERVAL_INVALID_DECIMAL + - code: ADVERTISEMENT_INTERVAL_REQD + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Spoke Cluster (v2.0) + tags: + - Site Configuration + /sdwan/v2.0/api/sites/{site_id}/spokeclusters/{spoke_cluster_id}/operations: + post: + description: Handle all the actions performed on the spoke cluster. + operationId: post-sdwan-v2.0-api-sites-site_id-spokeclusters-spoke_cluster_id-operations + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the spoke cluster. + in: path + name: spoke_cluster_id + required: true + schema: + description: Spoke Cluster Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeClusterOperations' + description: Spokecluster operation action + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeClusterOperations' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Handle Operations on Spokecluster (v2.0) + tags: + - Site Configuration + /sdwan/v2.0/api/sites/{site_id}/spokeclusters/{spoke_cluster_id}/status: + get: + description: Get the status of the spoke clusters. + operationId: get-sdwan-v2.0-api-sites-site_id-spokeclusters-spoke_cluster_id-status + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the spoke cluster. + in: path + name: spoke_cluster_id + required: true + schema: + description: Spoke Cluster Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeClusterStatus' + description: Successful Operation + summary: Get Spoke Cluster Status (v2.0) + tags: + - Site Configuration + /sdwan/v2.0/api/sites/{site_id}/status: + get: + description: Get the status of the site. + operationId: get-sdwan-v2.0-api-sites-site_id-status + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SiteStatus' + description: Successful Operation + summary: Get Site Status (v2.0) + tags: + - Site Configuration + /sdwan/v2.0/api/spokeclusters/query: + post: + description: Query the details for the spoke cluster. + operationId: post-sdwan-v2.0-api-spokeclusters-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SpokeClusterQuery' + description: Query Details for the spokecluster + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SpokeClusterQueryFilterResponse' + 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 Spoke Clusters (v2.0) + tags: + - Site Configuration + /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/waninterfaces/{wan_interface_id}/state: + get: + description: Get the status of the elemant WAN interface. + operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-waninterfaces-wan_interface_id-state + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the element. + in: path + name: element_id + required: true + schema: + description: Element Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementWANInterfaceState' + description: Successful Operation + summary: Get Element WAN Interface Status (v2.1) + tags: + - Site Configuration + /sdwan/v2.1/api/sites/{site_id}/waninterfaces: + get: + description: Get all Site WAN interfaces + operationId: get-sdwan-v2.1-api-sites-site_id-waninterfaces + parameters: + - description: Site Id + 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/WANInterface' + type: array + type: object + description: Successful Operation + summary: Get all Site WAN interfaces (v2.1) + tags: + - Site Configuration + post: + description: Create a site WAN interface. + operationId: post-sdwan-v2.1-api-sites-site_id-waninterfaces + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterface' + description: Successful Operation + summary: Create Site WAN Interface (v2.1) + tags: + - Site Configuration + /sdwan/v2.1/api/sites/{site_id}/waninterfaces/query: + post: + description: Queries the DB for Site WAN Interfaces that match the query parameters. + operationId: post-sdwan-v2.1-api-sites-site_id-waninterfaces-query + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site 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/WANInterfaceQuery' + type: array + type: object + description: Successful Operation + summary: Query DB for Site WAN Interfaces (v2.1) + tags: + - Site Configuration + /sdwan/v2.1/api/sites/{site_id}/waninterfaces/{wan_interface_id}: + delete: + description: Delete an existing WAN interface. + operationId: delete-sdwan-v2.1-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterface' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_CONFIGURED + - code: WAN_INTERFACE_CONFIG_IN_ZONE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete WAN Interface (v2.1) + tags: + - Site Configuration + get: + description: Get a specific site wan interface. + operationId: get-sdwan-v2.1-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterface' + description: Successful Operation + summary: Get Specific Site WAN Interface (v2.1) + tags: + - Site Configuration + put: + description: Update the site WAN interface. + operationId: put-sdwan-v2.1-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreen' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterface' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_DUPLICATE_LABEL_FOR_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Site WAN Interface (v2.1) + tags: + - Site Configuration + /sdwan/v2.1/api/sites/{site_id}/waninterfaces/{wan_interface_id}/status: + get: + description: Get the status of a specific site wan interface. + operationId: get-sdwan-v2.1-api-sites-site_id-waninterfaces-wan_interface_id-status + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceState' + description: Successful Operation + summary: Get Site WAN Interface Status (v2.1) + tags: + - Site Configuration + /sdwan/v2.2/api/sites/{site_id}/waninterfaces: + get: + description: List all the site WAN interfaces. + operationId: get-sdwan-v2.2-api-sites-site_id-waninterfaces + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + 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/WANInterfaceV2N3' + type: array + type: object + description: Successful Operation + summary: Get Site WAN Interfaces (v2.2) + tags: + - Site Configuration + post: + description: Create a new site WAN interface. + operationId: post-sdwan-v2.2-api-sites-site_id-waninterfaces + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_DUPLICATE_LABEL_FOR_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Site WAN Interface (v2.2) + tags: + - Site Configuration + /sdwan/v2.2/api/sites/{site_id}/waninterfaces/{wan_interface_id}: + delete: + description: Delete an existing WAN interface. + operationId: delete-sdwan-v2.2-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_CONFIGURED + - code: WAN_INTERFACE_CONFIG_IN_ZONE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete WAN Interface (v2.2) + tags: + - Site Configuration + get: + description: Get a specific site wan interface. + operationId: get-sdwan-v2.2-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N2' + description: Successful Operation + summary: Get Specific Site WAN Interface (v2.2) + tags: + - Site Configuration + put: + description: Update the site WAN interface. + operationId: put-sdwan-v2.2-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N2' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_DUPLICATE_LABEL_FOR_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Site WAN Interface (v2.2) + tags: + - Site Configuration + /sdwan/v2.3/api/sites/{site_id}/waninterfaces: + get: + description: List all the site WAN interfaces. + operationId: get-sdwan-v2.3-api-sites-site_id-waninterfaces + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + 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/WANInterfaceV2N3' + type: array + type: object + description: Successful Operation + summary: Get Site WAN Interfaces (v2.3) + tags: + - Site Configuration + post: + description: Create a new site WAN interface. + operationId: post-sdwan-v2.3-api-sites-site_id-waninterfaces + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N3' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_DUPLICATE_LABEL_FOR_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Site WAN Interface (v2.3) + tags: + - Site Configuration + /sdwan/v2.3/api/sites/{site_id}/waninterfaces/query: + post: + description: Queries the DB for Site WAN Interfaces that match the query parameters. + operationId: post-sdwan-v2.3-api-sites-site_id-waninterfaces-query + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site 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/WANInterfaceQuery' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + schema: + $ref: '#/components/schemas/Error' + description: Bad request + summary: Query DB for Site WAN Interfaces (v2.3) + tags: + - Site Configuration + /sdwan/v2.3/api/sites/{site_id}/waninterfaces/{wan_interface_id}: + delete: + description: Delete an existing WAN interface. + operationId: delete-sdwan-v2.3-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_CONFIGURED + - code: WAN_INTERFACE_CONFIG_IN_ZONE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete WAN Interface (v2.3) + tags: + - Site Configuration + get: + description: Get a specific site wan interface. + operationId: get-sdwan-v2.3-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N3' + description: Successful Operation + summary: Get Specific Site WAN Interface (v2.3) + tags: + - Site Configuration + put: + description: Update the site WAN interface. + operationId: put-sdwan-v2.3-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N3' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_DUPLICATE_LABEL_FOR_SITE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Site WAN Interface (v2.3) + tags: + - Site Configuration + /sdwan/v2.4/api/sites/{site_id}/waninterfaces: + get: + description: List all the site WAN interfaces. + operationId: get-sdwan-v2.4-api-sites-site_id-waninterfaces + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + 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/WANInterfaceV2N4' + type: array + type: object + description: Successful Operation + summary: Get Site WAN Interfaces (v2.4) + tags: + - Site Configuration + post: + description: Create a new site WAN interface. + operationId: post-sdwan-v2.4-api-sites-site_id-waninterfaces + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N4' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N4' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_DUPLICATE_LABEL_FOR_SITE + - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED + - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC + - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Site WAN Interface (v2.4) + tags: + - Site Configuration + /sdwan/v2.4/api/sites/{site_id}/waninterfaces/query: + post: + description: Queries the DB for Site WAN Interfaces that match the query parameters. + operationId: post-sdwan-v2.4-api-sites-site_id-waninterfaces-query + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site 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/WANInterfaceQuery' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Site WAN Interfaces (v2.4) + tags: + - Site Configuration + /sdwan/v2.4/api/sites/{site_id}/waninterfaces/{wan_interface_id}: + delete: + description: Delete an existing WAN interface. + operationId: delete-sdwan-v2.4-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N4' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_CONFIGURED + - code: WAN_INTERFACE_CONFIG_IN_ZONE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete WAN Interface (v2.4) + tags: + - Site Configuration + get: + description: Get a specific site wan interface. + operationId: get-sdwan-v2.4-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N4' + description: Successful Operation + summary: Get Specific Site WAN Interface (v2.4) + tags: + - Site Configuration + put: + description: Update the site WAN interface. + operationId: put-sdwan-v2.4-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N4' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N4' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_DUPLICATE_LABEL_FOR_SITE + - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED + - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC + - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Site WAN Interface (v2.4) + tags: + - Site Configuration + /sdwan/v2.5/api/sites/{site_id}/waninterfaces: + get: + description: List all the site WAN interfaces. + operationId: get-sdwan-v2.5-api-sites-site_id-waninterfaces + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + 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/WANInterfaceV2N5' + type: array + type: object + description: Successful Operation + summary: Get Site WAN Interfaces (v2.5) + tags: + - Site Configuration + post: + description: Create a new site WAN interface. + operationId: post-sdwan-v2.5-api-sites-site_id-waninterfaces + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N5' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N5' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Site WAN Interface (v2.5) + tags: + - Site Configuration + /sdwan/v2.5/api/sites/{site_id}/waninterfaces/query: + post: + description: Queries the DB for Site WAN Interfaces that match the query parameters. + operationId: post-sdwan-v2.5-api-sites-site_id-waninterfaces-query + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site 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/WANInterfaceQuery' + type: array + type: object + description: Successful Operation + summary: Query DB for Site WAN Interfaces (v2.5) + tags: + - Site Configuration + /sdwan/v2.5/api/sites/{site_id}/waninterfaces/{wan_interface_id}: + delete: + description: Delete an existing WAN interface. + operationId: delete-sdwan-v2.5-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N5' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_CONFIGURED + - code: WAN_INTERFACE_CONFIG_IN_ZONE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete WAN Interface (v2.5) + tags: + - Site Configuration + get: + description: Get a specific site wan interface. + operationId: get-sdwan-v2.5-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N5' + description: Successful Operation + summary: Get Specific Site WAN Interface (v2.5) + tags: + - Site Configuration + put: + description: Update the site WAN interface. + operationId: put-sdwan-v2.5-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N5' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N5' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED + - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC + - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Resource Not Found + summary: Update Site WAN Interface (v2.5) + tags: + - Site Configuration + /sdwan/v2.6/api/sites/{site_id}/waninterfaces: + get: + description: List all the site WAN interfaces. + operationId: get-sdwan-v2.6-api-sites-site_id-waninterfaces + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceV2N6' + type: array + type: object + description: Successful Operation + summary: Get Site WAN Interfaces (v2.6) + tags: + - Site Configuration + post: + description: Create a new site WAN interface. + operationId: post-sdwan-v2.6-api-sites-site_id-waninterfaces + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N6' + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/WANInterfaceV2N6' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Site WAN Interface (v2.6) + tags: + - Site Configuration + /sdwan/v2.6/api/sites/{site_id}/waninterfaces/{wan_interface_id}: + delete: + description: Delete an existing WAN interface. + operationId: delete-sdwan-v2.6-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N6' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: WAN_INTERFACE_CONFIGURED + - code: WAN_INTERFACE_CONFIG_IN_ZONE + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete WAN Interface (v2.6) + tags: + - Site Configuration get: - description: Get the hub service endpoints of a tenant. - operationId: get-sdwan-v2.0-api-hubserviceendpoints + description: Get a specific site wan interface. + operationId: get-sdwan-v2.6-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N6' + description: Successful Operation + summary: Get Specific Site WAN Interface (v2.6) + tags: + - Site Configuration + put: + description: Update the site WAN interface. + operationId: put-sdwan-v2.6-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N6' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N6' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED + - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC + - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Resource Not Found + summary: Update Site WAN Interface (v2.6) + tags: + - Site Configuration + /sdwan/v2.6/api/waninterfaces/query: + post: + description: Queries the DB for Site WAN Interfaces that match the query parameters. + operationId: post-sdwan-v2.6-api-waninterfaces-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceQuery' responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/BulkResponse' + - $ref: '#/components/schemas/ListResponse' - properties: items: items: - $ref: '#/components/schemas/HubServiceEndpointConfig' + $ref: '#/components/schemas/WANInterfaceQuery' type: array type: object description: Successful Operation - summary: Get HubServiceEndpoints of Tenant (v2.0) + summary: Query DB for Site WAN Interfaces (v2.6) tags: - Site Configuration - /sdwan/v2.0/api/sites/{site_id}/hubserviceendpoints: + /sdwan/v2.7/api/sites/{site_id}/waninterfaces: get: - description: Get the hub service endpoint for a site of a given tenant using - the tenant ID and site ID. - operationId: get-sdwan-v2.0-api-sites-site_id-hubserviceendpoints + description: List all the site WAN interfaces. + operationId: get-sdwan-v2.7-api-sites-site_id-waninterfaces parameters: - - description: ID of the remote site. More details on the site can be retrieved - by querying the sites API. + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + 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/WANInterfaceV2N7' + type: array + type: object + description: Successful Operation + summary: Get Site WAN Interfaces (v2.7) + tags: + - Site Configuration + post: + description: Create a new site WAN interface. + operationId: post-sdwan-v2.7-api-sites-site_id-waninterfaces + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N7' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N7' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED + - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC + - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT + - code: WANINTERFACE_USE_FOR_NON_HUB_PATHS_INVALID + - code: WANINTERFACE_USE_FOR_NON_HUB_PATHS_NOT_ALLOWED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Site WAN Interface (v2.7) + tags: + - Site Configuration + /sdwan/v2.7/api/sites/{site_id}/waninterfaces/{wan_interface_id}: + delete: + description: Delete an existing WAN interface. + operationId: delete-sdwan-v2.7-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. in: path name: site_id required: true schema: description: Site Id type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubServiceEndpointConfig' + $ref: '#/components/schemas/WANInterfaceV2N7' description: Successful Operation '400': content: @@ -2664,17 +5766,46 @@ paths: example: value: _error: - - code: SITE_NOT_FOUND + - code: WAN_INTERFACE_CONFIGURED + - code: WAN_INTERFACE_CONFIG_IN_ZONE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get HubServiceEndpoint for Site of a Tenant (v2.0) + summary: Delete WAN Interface (v2.7) tags: - Site Configuration - /sdwan/v2.0/api/sites/{site_id}/siteciphers: get: - description: List the ciphers for a particular site. - operationId: get-sdwan-v2.0-api-sites-site_id-siteciphers + description: Get a specific site wan interface. + operationId: get-sdwan-v2.7-api-sites-site_id-waninterfaces-wan_interface_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N7' + description: Successful Operation + summary: Get Specific Site WAN Interface (v2.7) + tags: + - Site Configuration + put: + description: Update the site WAN interface. + operationId: put-sdwan-v2.7-api-sites-site_id-waninterfaces-wan_interface_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -2684,26 +5815,100 @@ paths: schema: description: Site Id type: string + - description: ID of the WAN interface. + in: path + name: wan_interface_id + required: true + schema: + description: Wan Interface Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceScreenV2N7' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceV2N7' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID + - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH + - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND + - code: WANINTERFACE_CONFIG_INVALID_LABEL + - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED + - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE + - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC + - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS + - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL + - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT + - code: WANINTERFACE_USE_FOR_NON_HUB_PATHS_INVALID + - code: WANINTERFACE_USE_FOR_NON_HUB_PATHS_NOT_ALLOWED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Resource Not Found + summary: Update Site WAN Interface (v2.7) + tags: + - Site Configuration + /sdwan/v2.7/api/waninterfaces/query: + post: + description: Queries the DB for Site WAN Interfaces that match the query parameters. + operationId: post-sdwan-v2.7-api-waninterfaces-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WANInterfaceQuery' responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/BulkResponse' + - $ref: '#/components/schemas/ListQueryResponse' - properties: items: items: - $ref: '#/components/schemas/SiteCipher' + $ref: '#/components/schemas/WANInterfaceQueryFilterV2N7' type: array type: object description: Successful Operation - summary: Get Site Ciphers (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Query DB for Site WAN Interfaces (v2.7) tags: - Site Configuration + /sdwan/v3.0/api/sites/{site_id}/admin_state: put: - description: Update the ciphers for a particular site. - operationId: put-sdwan-v2.0-api-sites-site_id-siteciphers + description: Update an existing site. + operationId: put-sdwan-v3.0-api-sites-site_id-admin_state parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -2717,13 +5922,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteCipherScreen' + $ref: '#/components/schemas/Site' + description: Details of the site to update responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteCipher' + $ref: '#/components/schemas/Site' description: Successful Operation '400': content: @@ -2731,18 +5937,19 @@ paths: example: value: _error: + - code: SITE_NOT_FOUND - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_COMMON_ATTR_MISMATCH schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Site Cipher (v2.0) + summary: Update a Site (v3.0) tags: - Site Configuration - /sdwan/v2.0/api/sites/{site_id}/spokeclusters: + /sdwan/v3.0/api/sites/{site_id}/hubclusters: get: - description: List all the spoke clusters for a particular site. - operationId: get-sdwan-v2.0-api-sites-site_id-spokeclusters + description: List all the hub clusters. + operationId: get-sdwan-v3.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. @@ -2762,17 +5969,27 @@ paths: - properties: items: items: - $ref: '#/components/schemas/SpokeCluster' + $ref: '#/components/schemas/HubCluster' type: array type: object description: Successful Operation - summary: Get Spoke Clusters (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: INVALID_VALUE_RANGE + - code: NAME_EXCEEDS_LIMIT + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Hub Clusters (v3.0) tags: - Site Configuration post: - description: Create cluster to determine which data center communicates with - which branch devices. - operationId: post-sdwan-v2.0-api-sites-site_id-spokeclusters + description: Creates a new hub cluster. + operationId: post-sdwan-v3.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. @@ -2786,14 +6003,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SpokeCluster' - description: Details of the spokecluster to be created + $ref: '#/components/schemas/HubClusterScreen' + description: Details of the hub cluster to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SpokeCluster' + $ref: '#/components/schemas/HubCluster' description: Successful Operation '400': content: @@ -2801,49 +6018,79 @@ paths: example: value: _error: - - code: INVALID_JSON_INPUT - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: SPOKECLUSTER_CONFIG_INVALID_SITE - - code: SPOKECLUSTER_CONFIG_EXCEEDS_LIMIT - - code: ADVERTISEMENT_INTERVAL_INVALID_DECIMAL - - code: ADVERTISEMENT_INTERVAL_REQD + - code: INVALID_VALUE_RANGE + - code: NAME_EXCEEDS_LIMIT schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Spoke Cluster (v2.0) + summary: Create Hub Cluster (v3.0) tags: - Site Configuration - /sdwan/v2.0/api/sites/{site_id}/spokeclusters/query: - post: - description: Query the spoke clusters for a site. - operationId: post-sdwan-v2.0-api-sites-site_id-spokeclusters-query + /sdwan/v3.0/api/sites/{site_id}/hubclusters/{hub_cluster_id}: + delete: + description: Delete an existing WAN interface. + operationId: delete-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id parameters: - - description: The site ID for which you wish to query the spoke clusters. + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. in: path name: site_id required: true schema: description: Site Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SpokeClusterQuery' - description: Query Details for the spokecluster + - description: ID of the hub cluster. + in: path + name: hub_cluster_id + required: true + schema: + description: Hub Cluster Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SpokeClusterQueryFilter' - type: array - type: object + $ref: '#/components/schemas/HubCluster' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: CLUSTER_CONTAINS_CLUSTER_MEMBERS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Hub Cluster (v3.0) + tags: + - Site Configuration + get: + description: List a specific hub cluster. + operationId: get-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: ID of the hub cluster. + in: path + name: hub_cluster_id + required: true + schema: + description: Hub Cluster Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HubCluster' description: Successful Operation '400': content: @@ -2851,17 +6098,17 @@ paths: example: value: _error: - - code: BAD_REQUEST + - code: INVALID_VALUE_RANGE + - code: NAME_EXCEEDS_LIMIT schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query Spoke Clusters (v2.0) + summary: Get Specific Hub Cluster (v3.0 tags: - Site Configuration - /sdwan/v2.0/api/sites/{site_id}/spokeclusters/{spoke_cluster_id}: - delete: - description: Delete a spoke cluster. - operationId: delete-sdwan-v2.0-api-sites-site_id-spokeclusters-spoke_cluster_id + put: + description: Details of the hub cluster to be created. + operationId: put-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -2871,55 +6118,68 @@ paths: schema: description: Site Id type: string - - description: ID of the spoke cluster. + - description: ID of the hub cluster. in: path - name: spoke_cluster_id + name: hub_cluster_id required: true schema: - description: Spoke Cluster Id + description: Hub Cluster Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HubClusterScreen' + description: Details of the hub cluster to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SpokeCluster' + $ref: '#/components/schemas/HubCluster' description: Successful Operation - summary: Delete Spoke Cluster (v2.0) + summary: Update Hub Cluster (v3.0) tags: - Site Configuration + /sdwan/v3.0/api/sites/{site_id}/hubclusters/{hub_cluster_id}/hubclustermembers: get: - description: Get all the details of the spoke cluster. - operationId: get-sdwan-v2.0-api-sites-site_id-spokeclusters-spoke_cluster_id + description: Get all hub cluster members + operationId: get-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers 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 schema: description: Site Id type: string - - description: ID of the spoke cluster. + - description: Hub Cluster Id in: path - name: spoke_cluster_id + name: hub_cluster_id required: true schema: - description: Spoke Cluster Id + description: Hub Cluster Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SpokeCluster' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/HubClusterMemberScreen' + type: array + type: object description: Successful Operation - summary: Get Spoke Cluster Details (v2.0) + summary: Get all hub cluster members (v3.0) tags: - Site Configuration - put: - description: Details of the spoke cluster that needs to be modified. - operationId: put-sdwan-v2.0-api-sites-site_id-spokeclusters-spoke_cluster_id + post: + description: Creates new hub cluster members. + operationId: post-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -2929,47 +6189,33 @@ paths: schema: description: Site Id type: string - - description: ID of the spoke cluster. + - description: ID of the hub cluster. in: path - name: spoke_cluster_id + name: hub_cluster_id required: true schema: - description: Spoke Cluster Id + description: Hub Cluster Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SpokeCluster' - description: Details of the spokecluster to be modified + $ref: '#/components/schemas/HubClusterMemberScreen' + description: Details of the hub cluster member to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SpokeCluster' + $ref: '#/components/schemas/HubClusterMemberScreen' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: INVALID_JSON_INPUT - - 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 - summary: Update Spoke Cluster (v2.0) + summary: Creates all Hub Cluster Members (v3.0) tags: - Site Configuration - /sdwan/v2.0/api/sites/{site_id}/spokeclusters/{spoke_cluster_id}/operations: - post: - description: Handle all the actions performed on the spoke cluster. - operationId: post-sdwan-v2.0-api-sites-site_id-spokeclusters-spoke_cluster_id-operations + /sdwan/v3.0/api/sites/{site_id}/hubclusters/{hub_cluster_id}/hubclustermembers/{hub_cluster_member_id}: + delete: + description: Delete a specific hub cluster member. + operationId: delete-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers-hub_cluster_member_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -2979,25 +6225,26 @@ paths: schema: description: Site Id type: string - - description: ID of the spoke cluster. + - description: ID of the hub cluster. in: path - name: spoke_cluster_id + name: hub_cluster_id required: true schema: - description: Spoke Cluster Id + description: Hub Cluster Id + type: string + - description: ID of the hub cluster member. + in: path + name: hub_cluster_member_id + required: true + schema: + description: Hub Cluster Member Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SpokeClusterOperations' - description: Spokecluster operation action responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SpokeClusterOperations' + $ref: '#/components/schemas/HubClusterMember' description: Successful Operation '400': content: @@ -3005,17 +6252,16 @@ paths: example: value: _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: BAD_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Handle Operations on Spokecluster (v2.0) + summary: Deletes Specific Hub Cluster Member (v3.0) tags: - Site Configuration - /sdwan/v2.0/api/sites/{site_id}/spokeclusters/{spoke_cluster_id}/status: get: - description: Get the status of the spoke clusters. - operationId: get-sdwan-v2.0-api-sites-site_id-spokeclusters-spoke_cluster_id-status + description: List a specific hub cluster member. + operationId: get-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers-hub_cluster_member_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -3025,87 +6271,35 @@ paths: schema: description: Site Id type: string - - description: ID of the spoke cluster. + - description: ID of the hub cluster. in: path - name: spoke_cluster_id + name: hub_cluster_id required: true schema: - description: Spoke Cluster Id + description: Hub Cluster Id type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SpokeClusterStatus' - description: Successful Operation - summary: Get Spoke Cluster Status (v2.0) - tags: - - Site Configuration - /sdwan/v2.0/api/sites/{site_id}/status: - get: - description: Get the status of the site. - operationId: get-sdwan-v2.0-api-sites-site_id-status - parameters: - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. + - description: ID of the hub cluster member. in: path - name: site_id + name: hub_cluster_member_id required: true schema: - description: Site Id + description: Hub Cluster Member Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteStatus' - description: Successful Operation - summary: Get Site Status (v2.0) - tags: - - Site Configuration - /sdwan/v2.0/api/spokeclusters/query: - post: - description: Query the details for the spoke cluster. - operationId: post-sdwan-v2.0-api-spokeclusters-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SpokeClusterQuery' - description: Query Details for the spokecluster - responses: - '200': - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/SpokeClusterQueryFilterResponse' - type: array - type: object + items: + $ref: '#/components/schemas/HubClusterMember' + type: array description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: BAD_REQUEST - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - summary: Query Spoke Clusters (v2.0) + summary: Get Specific Hub Cluster Member (v3.0) tags: - Site Configuration - /sdwan/v2.1/api/sites/{site_id}/elements/{element_id}/waninterfaces/{wan_interface_id}/state: - get: - description: Get the status of the elemant WAN interface. - operationId: get-sdwan-v2.1-api-sites-site_id-elements-element_id-waninterfaces-wan_interface_id-state + put: + description: Details of the hub cluster member to be created. + operationId: put-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers-hub_cluster_member_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -3115,34 +6309,42 @@ paths: schema: description: Site Id type: string - - description: ID of the element. + - description: ID of the hub cluster. in: path - name: element_id + name: hub_cluster_id required: true schema: - description: Element Id + description: Hub Cluster Id type: string - - description: ID of the WAN interface. + - description: ID of the hub cluster member. in: path - name: wan_interface_id + name: hub_cluster_member_id required: true schema: - description: Wan Interface Id + description: Hub Cluster Member Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HubClusterMemberScreen' + description: Details of the hub cluster member to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ElementWANInterfaceState' + items: + $ref: '#/components/schemas/HubClusterMemberScreen' + type: array description: Successful Operation - summary: Get Element WAN Interface Status (v2.1) + summary: Update Specific Hub Cluster Member (v3.0) tags: - Site Configuration - /sdwan/v2.1/api/sites/{site_id}/waninterfaces/{wan_interface_id}/status: + /sdwan/v3.0/api/sites/{site_id}/hubclusters/{hub_cluster_id}/hubclustermembers/{hub_cluster_member_id}/status: get: - description: Get the status of a specific site wan interface. - operationId: get-sdwan-v2.1-api-sites-site_id-waninterfaces-wan_interface_id-status + description: List the state of a specific hub cluster member. + operationId: get-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers-hub_cluster_member_id-status parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -3152,27 +6354,36 @@ paths: schema: description: Site Id type: string - - description: ID of the WAN interface. + - description: ID of the hub cluster. in: path - name: wan_interface_id + name: hub_cluster_id required: true schema: - description: Wan Interface Id + description: Hub Cluster Id + type: string + - description: ID of the hub cluster member. + in: path + name: hub_cluster_member_id + required: true + schema: + description: Hub Cluster Member Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceState' + items: + $ref: '#/components/schemas/HubClusterMember' + type: array description: Successful Operation - summary: Get Site WAN Interface Status (v2.1) + summary: Get Specific Hub Cluster Member State (v3.0) tags: - Site Configuration - /sdwan/v2.4/api/sites/{site_id}/waninterfaces/query: - post: - description: Queries the DB for Site WAN Interfaces that match the query parameters. - operationId: post-sdwan-v2.4-api-sites-site_id-waninterfaces-query + /sdwan/v3.0/api/sites/{site_id}/hubclusters/{hub_cluster_id}/status: + get: + description: List the state of a specific hub cluster. + operationId: get-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id-status parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -3182,24 +6393,19 @@ paths: schema: description: Site Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/WANInterfaceQuery' + - description: ID of the hub cluster. + in: path + name: hub_cluster_id + required: true + schema: + description: Hub Cluster Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/WANInterfaceQuery' - type: array - type: object + $ref: '#/components/schemas/HubCluster' description: Successful Operation '400': content: @@ -3207,32 +6413,24 @@ paths: example: value: _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: WANINTERFACE_CONFIG_INVALID_SITE_ID + - code: INVALID_VALUE_RANGE + - code: NAME_EXCEEDS_LIMIT schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Site WAN Interfaces (v2.4) + summary: Get Specific Hub Cluster State (v3.0) tags: - Site Configuration - /sdwan/v2.5/api/sites/{site_id}/waninterfaces/query: + /sdwan/v4.0/api/hubclusters/query: post: - description: Queries the DB for Site WAN Interfaces that match the query parameters. - operationId: post-sdwan-v2.5-api-sites-site_id-waninterfaces-query - parameters: - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string + description: Run a query to return details of the hub clusters. + operationId: post-sdwan-v4.0-api-hubclusters-query requestBody: content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceQuery' + $ref: '#/components/schemas/HubClusterQueryV4' + description: Details of the hub cluster to be created. responses: '200': content: @@ -3243,17 +6441,27 @@ paths: - properties: items: items: - $ref: '#/components/schemas/WANInterfaceQuery' + $ref: '#/components/schemas/HubClusterQueryFilterV4' type: array type: object - description: Successful Operation - summary: Query DB for Site WAN Interfaces (v2.5) + description: Successful operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_QUERY_OR_SORT_PARAMETERS + schema: + $ref: '#/components/schemas/Error' + description: Bad request + summary: Query Hub Clusters (v4.0) tags: - Site Configuration - /sdwan/v2.6/api/sites/{site_id}/waninterfaces: + /sdwan/v4.0/api/sites/{site_id}/hubclusters: get: - description: List all the site WAN interfaces. - operationId: get-sdwan-v2.6-api-sites-site_id-waninterfaces + description: List all the 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. @@ -3273,16 +6481,16 @@ paths: - properties: items: items: - $ref: '#/components/schemas/WANInterfaceV2N6' + $ref: '#/components/schemas/HubClusterV4' type: array type: object - description: Successful Operation - summary: Get Site WAN Interfaces (v2.6) + description: Successful operation + summary: Get Hub Clusters (v4.0) tags: - Site Configuration post: - description: Create a new site WAN interface. - operationId: post-sdwan-v2.6-api-sites-site_id-waninterfaces + description: Create 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. @@ -3296,38 +6504,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceScreenV2N6' + $ref: '#/components/schemas/HubClusterV4' + description: Details of the hub cluster to be created responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/BulkResponse' - - properties: - items: - items: - $ref: '#/components/schemas/WANInterfaceV2N6' - type: array - type: object - description: Successful Operation + $ref: '#/components/schemas/HubClusterV4' + description: Successful operation '400': content: application/json: example: value: _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: HUB_CLUSTER_NAME_NULL_OR_EMPTY + - code: HUB_CLUSTER_NAME_EXCEEDS_LIMIT + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INVALID_TAG + - code: INVALID_HUB_SITE + - code: HUB_CLUSTER_ELEMENT_PRESENT + - code: DEFAULT_HUB_CLUSTER_EXISTS + - code: HUB_CLUSTER_NAME_NOT_UNIQUE + - code: HUB_CLUSTER_COUNT_IN_HUB_SITE_EXCEEDED + - code: DUPLICATE_SPOKE_SITES_PRESENT + - code: INVALID_PEER_SITES_PRESENT + - code: SOME_SPOKE_SITES_ALREADY_MAPPED_TO_ANOTHER_CLUSTER + - code: INVALID_VALUE_RANGE schema: $ref: '#/components/schemas/Error' - description: Bad Request - summary: Create Site WAN Interface (v2.6) + description: Bad request + summary: Create Hub Cluster (v4.0) tags: - Site Configuration - /sdwan/v2.6/api/sites/{site_id}/waninterfaces/{wan_interface_id}: + /sdwan/v4.0/api/sites/{site_id}/hubclusters/{hub_cluster_id}: delete: - description: Delete an existing WAN interface. - operationId: delete-sdwan-v2.6-api-sites-site_id-waninterfaces-wan_interface_id + description: Delete a hub cluster. + operationId: delete-sdwan-v4.0-api-sites-site_id-hubclusters-hub_cluster_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -3337,37 +6551,37 @@ paths: schema: description: Site Id type: string - - description: ID of the WAN interface. + - description: ID of the hub cluster. in: path - name: wan_interface_id + name: hub_cluster_id required: true schema: - description: Wan Interface Id + description: Hub Cluster Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceV2N6' - description: Successful Operation + $ref: '#/components/schemas/HubClusterV4' + description: Successful operation '400': content: application/json: example: value: _error: - - code: WAN_INTERFACE_CONFIGURED - - code: WAN_INTERFACE_CONFIG_IN_ZONE + - code: HUB_CLUSTER_NOT_FOUND + - code: HUB_CLUSTER_HAS_ELEMENTS schema: $ref: '#/components/schemas/Error' - description: Bad Request - summary: Delete WAN Interface (v2.6) + description: Bad request + summary: Delete Hub Cluster (v4.0) tags: - Site Configuration get: - description: Get a specific site wan interface. - operationId: get-sdwan-v2.6-api-sites-site_id-waninterfaces-wan_interface_id + description: List a specific hub cluster. + operationId: get-sdwan-v4.0-api-sites-site_id-hubclusters-hub_cluster_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -3377,26 +6591,36 @@ paths: schema: description: Site Id type: string - - description: ID of the WAN interface. + - description: ID of the hub cluster. in: path - name: wan_interface_id + name: hub_cluster_id required: true schema: - description: Wan Interface Id + description: Hub Cluster Id type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceV2N6' - description: Successful Operation - summary: Get Specific Site WAN Interface (v2.6) + $ref: '#/components/schemas/HubClusterV4' + description: Successful operation + '404': + content: + application/json: + example: + value: + _error: + - code: HUB_CLUSTER_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Hub cluster not found + summary: Get Specific Hub Cluster (v4.0) tags: - Site Configuration put: - description: Update the site WAN interface. - operationId: put-sdwan-v2.6-api-sites-site_id-waninterfaces-wan_interface_id + description: Update the hub cluster. + operationId: put-sdwan-v4.0-api-sites-site_id-hubclusters-hub_cluster_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -3406,88 +6630,109 @@ paths: schema: description: Site Id type: string - - description: ID of the WAN interface. + - description: ID of the hub cluster. in: path - name: wan_interface_id + name: hub_cluster_id required: true schema: - description: Wan Interface Id + description: Hub Cluster Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceScreenV2N6' + $ref: '#/components/schemas/HubClusterV4' + description: Details of the hub cluster to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceScreenV2N6' - description: Successful Operation + $ref: '#/components/schemas/HubClusterV4' + description: Successful operation '400': content: application/json: example: value: _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: WANINTERFACE_CONFIG_INVALID_SITE_ID - - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID - - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH - - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND - - code: WANINTERFACE_CONFIG_INVALID_LABEL - - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED - - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE - - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC - - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP - - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL - - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - '404': - content: - application/json: + - code: HUB_CLUSTER_NAME_NULL_OR_EMPTY + - code: HUB_CLUSTER_NAME_EXCEEDS_LIMIT + - code: DESCRIPTION_EXCEEDS_LIMIT + - code: INVALID_TAG + - code: HUB_CLUSTER_NOT_FOUND + - code: DEFAULT_HUB_CLUSTER_EXISTS + - code: HUB_CLUSTER_NAME_NOT_UNIQUE + - code: HUB_CLUSTER_INVALID_ELEMENTS_INFO + - code: DUPLICATE_SPOKE_SITES_PRESENT + - code: INVALID_PEER_SITES_PRESENT + - code: SOME_SPOKE_SITES_ALREADY_MAPPED_TO_ANOTHER_CLUSTER + - code: HUB_CLUSTER_UNDER_MAINTENANCE + - code: HUB_CLUSTER_STATUS_NOT_FOUND schema: $ref: '#/components/schemas/Error' - description: Resource Not Found - summary: Update Site WAN Interface (v2.6) + description: Bad request + summary: Update Hub Cluster (v4.0) tags: - Site Configuration - /sdwan/v2.6/api/waninterfaces/query: + /sdwan/v4.0/api/sites/{site_id}/hubclusters/{hub_cluster_id}/operations: post: - description: Queries the DB for Site WAN Interfaces that match the query parameters. - operationId: post-sdwan-v2.6-api-waninterfaces-query + description: The operations performed on the hub cluster. + operationId: post-sdwan-v4.0-api-sites-site_id-hubclusters-hub_cluster_id-operations + parameters: + - description: The ID of the site associated with the hub cluster. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string + - description: The ID of the hub cluster. + in: path + name: hub_cluster_id + required: true + schema: + description: Hub Cluster Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceQuery' + $ref: '#/components/schemas/HubClusterOperationV4' + description: Details of the operations to be performed on the hub cluster. responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/WANInterfaceQuery' - type: array - type: object - description: Successful Operation - summary: Query DB for Site WAN Interfaces (v2.6) + $ref: '#/components/schemas/HubClusterStatusV4' + description: Successful operation + '400': + content: + application/json: + example: + value: + _error: + - code: HUB_CLUSTER_INVALID_OPERATION + - code: HUB_ELEMENT_ID_NULL_OR_EMPTY + - code: HUB_CLUSTER_OPERATION_SPOKE_SITES_CANNOT_BE_EMPTY + - code: HUB_CLUSTER_OR_STATUS_NOT_FOUND + - code: HUB_CLUSTER_EMPTY + - code: HUB_CLUSTER_ELEMENT_NOT_LOCKED + - code: HUB_ELEMENT_NOT_PRESENT_IN_HUB_CLUSTER + - code: HUB_CLUSTER_DOES_NOT_CATER_TO_SPECIFIED_SPOKE_SITES + - code: HUB_CLUSTER_NEW_HUB_ELEMENT_NOT_FOUND + - code: HUB_CLUSTER_ELEMENT_DOES_NOT_CATER_TO_SPECIFIED_SPOKE_SITES + schema: + $ref: '#/components/schemas/Error' + description: Bad request + summary: Operations Hub Cluster API (v4.0) tags: - Site Configuration - /sdwan/v2.7/api/sites/{site_id}/waninterfaces: + /sdwan/v4.0/api/sites/{site_id}/hubclusters/{id}/status: get: - description: List all the site WAN interfaces. - operationId: get-sdwan-v2.7-api-sites-site_id-waninterfaces + description: Get the state of the hub cluster. + operationId: get-sdwan-v4.0-api-sites-site_id-hubclusters-id-status parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -3497,6 +6742,33 @@ paths: schema: description: Site Id type: string + - description: Hub Cluster Id + in: path + name: id + required: true + schema: + description: Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/HubClusterStatusV4' + description: Successful operation + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Hub Cluster not found + summary: Get Hub Cluster Status (v4.0) + tags: + - Site Configuration + /sdwan/v4.1/api/sites: + get: + description: Get all the sites of a tenant. + operationId: get-sdwan-v4.1-api-sites responses: '200': content: @@ -3507,36 +6779,28 @@ paths: - properties: items: items: - $ref: '#/components/schemas/WANInterfaceV2N7' + $ref: '#/components/schemas/Site' type: array type: object description: Successful Operation - summary: Get Site WAN Interfaces (v2.7) + summary: Get Sites of a Tenant (v4.1) tags: - Site Configuration post: - description: Create a new site WAN interface. - operationId: post-sdwan-v2.7-api-sites-site_id-waninterfaces - parameters: - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string + description: Create a new site. + operationId: post-sdwan-v4.1-api-sites requestBody: content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceScreenV2N7' + $ref: '#/components/schemas/Site' + description: Details of the site to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceV2N7' + $ref: '#/components/schemas/Site' description: Successful Operation '400': content: @@ -3544,55 +6808,44 @@ paths: example: value: _error: + - code: SITE_ALREADY_EXISTS + - code: SITE_ADMIN_STATE_MISSING + - code: SITE_ROLE_MISSING + - code: INVALID_PRIORITY_POLICYSETSTACK_ID + - code: INVALID_EXTENDED_TAG_SIZE_OR_DUPLICATE + - code: INVALID_NETWORK_POLICYSETSTACK_ID + - code: INVALID_NAT_POLICYSETSTACK_ID - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: WANINTERFACE_CONFIG_INVALID_SITE_ID - - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID - - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH - - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND - - code: WANINTERFACE_CONFIG_INVALID_LABEL - - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED - - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE - - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC - - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP - - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL - - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT - - code: WANINTERFACE_USE_FOR_NON_HUB_PATHS_INVALID - - code: WANINTERFACE_USE_FOR_NON_HUB_PATHS_NOT_ALLOWED + - code: POLICY_NOT_AVAILABLE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Site WAN Interface (v2.7) + summary: Create a New Site (v4.1) tags: - Site Configuration - /sdwan/v2.7/api/sites/{site_id}/waninterfaces/{wan_interface_id}: - delete: - description: Delete an existing WAN interface. - operationId: delete-sdwan-v2.7-api-sites-site_id-waninterfaces-wan_interface_id - parameters: - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: ID of the WAN interface. - in: path - name: wan_interface_id - required: true - schema: - description: Wan Interface Id - type: string + /sdwan/v4.1/api/sites/query: + post: + description: Queries the DB for limit number of sites that match the query parameters. + operationId: post-sdwan-v4.1-api-sites-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteQuery' + description: Query Details for the site responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceV2N7' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SiteQueryFilter' + type: array + type: object description: Successful Operation '400': content: @@ -3600,46 +6853,17 @@ paths: example: value: _error: - - code: WAN_INTERFACE_CONFIGURED - - code: WAN_INTERFACE_CONFIG_IN_ZONE + - code: BAD_QUERY_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete WAN Interface (v2.7) - tags: - - Site Configuration - get: - description: Get a specific site wan interface. - operationId: get-sdwan-v2.7-api-sites-site_id-waninterfaces-wan_interface_id - parameters: - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: ID of the WAN interface. - in: path - name: wan_interface_id - required: true - schema: - description: Wan Interface Id - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/WANInterfaceV2N7' - description: Successful Operation - summary: Get Specific Site WAN Interface (v2.7) + summary: Query DB for Number of Sites that Match Query Params (v4.1) tags: - Site Configuration - put: - description: Update the site WAN interface. - operationId: put-sdwan-v2.7-api-sites-site_id-waninterfaces-wan_interface_id + /sdwan/v4.1/api/sites/{site_id}: + delete: + description: Delete a particular site. + operationId: delete-sdwan-v4.1-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -3649,24 +6873,12 @@ paths: schema: description: Site Id type: string - - description: ID of the WAN interface. - in: path - name: wan_interface_id - required: true - schema: - description: Wan Interface Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/WANInterfaceScreenV2N7' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WANInterfaceV2N7' + $ref: '#/components/schemas/Site' description: Successful Operation '400': content: @@ -3674,57 +6886,37 @@ paths: example: value: _error: - - code: INVALID_JSON_EXTRA_ATTRIBUTE - - code: WANINTERFACE_CONFIG_INVALID_SITE_ID - - code: WANINTERFACE_CONFIG_INVALID_NETWORK_ID - - code: WANINTERFACE_CONFIG_INVALID_BANDWIDTH - - code: WANINTERFACE_CONFIG_LABEL_NOT_FOUND - - code: WANINTERFACE_CONFIG_INVALID_LABEL - - code: WANINTERFACE_LQM_CONFIG_NOT_ALLOWED - - code: WANINTERFACE_LQM_CONFIG_INVALID_FIELDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE - - code: WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC - - code: WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS - - code: WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP - - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL - - code: VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT - - code: WANINTERFACE_USE_FOR_NON_HUB_PATHS_INVALID - - code: WANINTERFACE_USE_FOR_NON_HUB_PATHS_NOT_ALLOWED + - code: SITE_ALREADY_EXISTS + - code: UNKNOWN_SITE + - 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: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS schema: $ref: '#/components/schemas/Error' description: Bad Request - '404': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Resource Not Found - summary: Update Site WAN Interface (v2.7) + summary: Delete a Site (v4.1) tags: - Site Configuration - /sdwan/v2.7/api/waninterfaces/query: - post: - description: Queries the DB for Site WAN Interfaces that match the query parameters. - operationId: post-sdwan-v2.7-api-waninterfaces-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/WANInterfaceQuery' + get: + description: Get the site if a particular tenant. + operationId: get-sdwan-v4.1-api-sites-site_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. + in: path + name: site_id + required: true + schema: + description: Site Id + type: string responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/WANInterfaceQueryFilterV2N7' - type: array - type: object + $ref: '#/components/schemas/Site' description: Successful Operation '400': content: @@ -3732,17 +6924,16 @@ paths: example: value: _error: - - code: BAD_REQUEST + - code: SITE_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for Site WAN Interfaces (v2.7) + summary: Get Site of Tenant (v4.1) tags: - Site Configuration - /sdwan/v3.0/api/sites/{site_id}/admin_state: put: description: Update an existing site. - operationId: put-sdwan-v3.0-api-sites-site_id-admin_state + operationId: put-sdwan-v4.1-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -3771,28 +6962,26 @@ paths: example: value: _error: - - code: SITE_NOT_FOUND + - code: SITE_ALREADY_EXISTS + - code: SITE_ADMIN_STATE_MISSING + - code: SITE_ROLE_MISSING + - code: INVALID_PRIORITY_POLICYSETSTACK_ID + - code: INVALID_EXTENDED_TAG_SIZE_OR_DUPLICATE + - code: INVALID_NETWORK_POLICYSETSTACK_ID + - code: INVALID_NAT_POLICYSETSTACK_ID - code: INVALID_JSON_EXTRA_ATTRIBUTE - code: INVALID_JSON_COMMON_ATTR_MISMATCH + - code: SITE_CONFIG_POLICYSET_DOES_NOT_EXIST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update a Site (v3.0) + summary: Update a Site (v4.1) tags: - Site Configuration - /sdwan/v3.0/api/sites/{site_id}/hubclusters: + /sdwan/v4.2/api/sites: get: - description: List all the hub clusters. - operationId: get-sdwan-v3.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. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string + description: Get the sites if a particular tenant. + operationId: get-sdwan-v4.2-api-sites responses: '200': content: @@ -3803,48 +6992,67 @@ paths: - properties: items: items: - $ref: '#/components/schemas/HubCluster' + $ref: '#/components/schemas/SiteV4N2' type: array type: object description: Successful Operation + summary: Get Sites of Tenant (v4.2) + tags: + - Site Configuration + post: + description: Create a new site. + operationId: post-sdwan-v4.2-api-sites + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N2' + description: Details of the site to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N2' + description: Successful Operation '400': content: application/json: example: value: _error: - - code: INVALID_VALUE_RANGE - - code: NAME_EXCEEDS_LIMIT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_SITE_CONFIG + - code: POLICY_NOT_AVAILABLE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Hub Clusters (v3.0) + summary: Create a New Site (v4.2) tags: - Site Configuration + /sdwan/v4.2/api/sites/query: post: - description: Creates a new hub cluster. - operationId: post-sdwan-v3.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. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string + description: Queries the DB for limit number of sites that match the query parameters. + operationId: post-sdwan-v4.2-api-sites-query requestBody: content: application/json: schema: - $ref: '#/components/schemas/HubClusterScreen' - description: Details of the hub cluster to be created + $ref: '#/components/schemas/SiteQuery' + description: Query Details for the site responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubCluster' + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SiteQueryFilterV4N2' + type: array + type: object description: Successful Operation '400': content: @@ -3852,18 +7060,17 @@ paths: example: value: _error: - - code: INVALID_VALUE_RANGE - - code: NAME_EXCEEDS_LIMIT + - code: BAD_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Hub Cluster (v3.0) + summary: Query DB for Number of Sites that Match Query Params (v4.2) tags: - Site Configuration - /sdwan/v3.0/api/sites/{site_id}/hubclusters/{hub_cluster_id}: + /sdwan/v4.2/api/sites/{site_id}: delete: - description: Delete an existing WAN interface. - operationId: delete-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id + description: Delete a particular site. + operationId: delete-sdwan-v4.2-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -3873,19 +7080,12 @@ paths: schema: description: Site Id type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubCluster' + $ref: '#/components/schemas/SiteV4N2' description: Successful Operation '400': content: @@ -3893,16 +7093,22 @@ paths: example: value: _error: - - code: CLUSTER_CONTAINS_CLUSTER_MEMBERS + - code: SITE_NOT_FOUND + - code: UNKNOWN_SITE + - 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: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Hub Cluster (v3.0) + summary: Delete a Site (v4.2) tags: - Site Configuration get: - description: List a specific hub cluster. - operationId: get-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id + description: Get the site of a particular tenant. + operationId: get-sdwan-v4.2-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -3912,19 +7118,12 @@ paths: schema: description: Site Id type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubCluster' + $ref: '#/components/schemas/SiteV4N2' description: Successful Operation '400': content: @@ -3932,17 +7131,16 @@ paths: example: value: _error: - - code: INVALID_VALUE_RANGE - - code: NAME_EXCEEDS_LIMIT + - code: SITE_NOT_FOUND schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Specific Hub Cluster (v3.0 + summary: Get Site of Tenant (v4.2) tags: - Site Configuration put: - description: Details of the hub cluster to be created. - operationId: put-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id + description: Update an existing site. + operationId: put-sdwan-v4.2-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -3952,133 +7150,70 @@ paths: schema: description: Site Id type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/HubClusterScreen' - description: Details of the hub cluster to be created + $ref: '#/components/schemas/SiteV4N2' + description: Details of the site to update responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubCluster' + $ref: '#/components/schemas/SiteV4N2' description: Successful Operation - summary: Update Hub Cluster (v3.0) + '400': + content: + application/json: + example: + value: + _error: + - code: SITE_NOT_FOUND + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update a Site (v4.2) tags: - Site Configuration - /sdwan/v3.0/api/sites/{site_id}/hubclusters/{hub_cluster_id}/hubclustermembers: + /sdwan/v4.3/api/sites: get: - description: Get all hub cluster members - operationId: get-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers - parameters: - - description: Site Id - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: Hub Cluster Id - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string + description: Get the sites if a particular tenant. + operationId: get-sdwan-v4.3-api-sites responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - $ref: '#/components/schemas/HubClusterMemberScreen' + $ref: '#/components/schemas/SiteV4N3' type: array type: object description: Successful Operation - summary: Get all hub cluster members (v3.0) + summary: Get Sites of Tenant (v4.3) tags: - Site Configuration post: - description: Creates new hub cluster members. - operationId: post-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers - parameters: - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string + description: Create a new site. + operationId: post-sdwan-v4.3-api-sites requestBody: content: application/json: schema: - $ref: '#/components/schemas/HubClusterMemberScreen' - description: Details of the hub cluster member to be created - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/HubClusterMemberScreen' - description: Successful Operation - summary: Creates all Hub Cluster Members (v3.0) - tags: - - Site Configuration - /sdwan/v3.0/api/sites/{site_id}/hubclusters/{hub_cluster_id}/hubclustermembers/{hub_cluster_member_id}: - delete: - description: Delete a specific hub cluster member. - operationId: delete-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers-hub_cluster_member_id - parameters: - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string - - description: ID of the hub cluster member. - in: path - name: hub_cluster_member_id - required: true - schema: - description: Hub Cluster Member Id - type: string + $ref: '#/components/schemas/SiteV4N3' + description: Details of the site to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubClusterMember' + $ref: '#/components/schemas/SiteV4N3' description: Successful Operation '400': content: @@ -4086,54 +7221,46 @@ paths: example: value: _error: - - code: BAD_REQUEST + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_SITE_CONFIG + - code: POLICY_NOT_AVAILABLE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Deletes Specific Hub Cluster Member (v3.0) + summary: Create a New Site (v4.3) tags: - Site Configuration - get: - description: List a specific hub cluster member. - operationId: get-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers-hub_cluster_member_id - parameters: - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string - - description: ID of the hub cluster member. - in: path - name: hub_cluster_member_id - required: true - schema: - description: Hub Cluster Member Id - type: string + /sdwan/v4.3/api/sites/query: + post: + description: Queries the DB for limit number of sites that match the query parameters. + operationId: post-sdwan-v4.3-api-sites-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteQuery' + description: Query Details for the site responses: '200': content: application/json: schema: - items: - $ref: '#/components/schemas/HubClusterMember' - type: array + allOf: + - $ref: '#/components/schemas/ListQueryResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SiteQueryFilterV4N3' + type: array + type: object description: Successful Operation - summary: Get Specific Hub Cluster Member (v3.0) + summary: Query DB for Number of Sites that Match Query Params (v4.3) tags: - Site Configuration - put: - description: Details of the hub cluster member to be created. - operationId: put-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers-hub_cluster_member_id + /sdwan/v4.3/api/sites/{site_id}: + delete: + description: Delete a particular site. + operationId: delete-sdwan-v4.3-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4142,43 +7269,36 @@ paths: required: true schema: description: Site Id - type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string - - description: ID of the hub cluster member. - in: path - name: hub_cluster_member_id - required: true - schema: - description: Hub Cluster Member Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/HubClusterMemberScreen' - description: Details of the hub cluster member to be created + type: string responses: '200': content: application/json: schema: - items: - $ref: '#/components/schemas/HubClusterMemberScreen' - type: array + $ref: '#/components/schemas/SiteV4N3' description: Successful Operation - summary: Update Specific Hub Cluster Member (v3.0) + '400': + content: + application/json: + example: + value: + _error: + - code: SITE_NOT_FOUND + - code: UNKNOWN_SITE + - 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: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete a Site (v4.3) tags: - Site Configuration - /sdwan/v3.0/api/sites/{site_id}/hubclusters/{hub_cluster_id}/hubclustermembers/{hub_cluster_member_id}/status: get: - description: List the state of a specific hub cluster member. - operationId: get-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id-hubclustermembers-hub_cluster_member_id-status + description: Get the site of a particular tenant. + operationId: get-sdwan-v4.3-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4188,36 +7308,29 @@ paths: schema: description: Site Id type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string - - description: ID of the hub cluster member. - in: path - name: hub_cluster_member_id - required: true - schema: - description: Hub Cluster Member Id - type: string responses: '200': content: application/json: schema: - items: - $ref: '#/components/schemas/HubClusterMember' - type: array + $ref: '#/components/schemas/SiteV4N3' description: Successful Operation - summary: Get Specific Hub Cluster Member State (v3.0) + '400': + content: + application/json: + example: + value: + _error: + - code: SITE_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Site of Tenant (v4.3) tags: - Site Configuration - /sdwan/v3.0/api/sites/{site_id}/hubclusters/{hub_cluster_id}/status: - get: - description: List the state of a specific hub cluster. - operationId: get-sdwan-v3.0-api-sites-site_id-hubclusters-hub_cluster_id-status + put: + description: Update an existing site. + operationId: put-sdwan-v4.3-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4227,19 +7340,18 @@ paths: schema: description: Site Id type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N3' + description: Details of the site to update responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubCluster' + $ref: '#/components/schemas/SiteV4N3' description: Successful Operation '400': content: @@ -4247,133 +7359,147 @@ paths: example: value: _error: - - code: INVALID_VALUE_RANGE - - code: NAME_EXCEEDS_LIMIT + - code: POLICY_CONFIG_INVALID_FOR_HUB_SITE + - code: INVALID_SECURITY_POLICYSET + - code: INVALID_POLICY_CONFIGURATION + - code: INVALID_NETWORK_POLICYSETSTACK + - code: DEFAULT_NETWORK_POLICYSETSTACK_NOT_AVAILABLE + - code: INVALID_PRIORITY_POLICYSETSTACK + - code: DEFAULT_PRIORITY_POLICYSETSTACK_NOT_AVAILABLE + - code: POLICYSETSTACK_CONFIG_NOT_SUPPORTED + - code: DEFAULT_POLICY_NOT_CONFIGURED + - code: SITE_CONFIG_SERVICEBINDING_INVALID_FOR_HUB + - code: SITE_CONFIG_SERVICEBINDING_DOES_NOT_EXIST + - code: INVALID_POLICYSET + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Specific Hub Cluster State (v3.0) + summary: Update a Site (v4.3) tags: - Site Configuration - /sdwan/v4.0/api/hubclusters/query: - post: - description: Run a query to return details of the hub clusters. - operationId: post-sdwan-v4.0-api-hubclusters-query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/HubClusterQueryV4' - description: Details of the hub cluster to be created + /sdwan/v4.4/api/sites: + get: + description: Get the sites if a particular tenant. + operationId: get-sdwan-v4.4-api-sites responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListQueryResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - $ref: '#/components/schemas/HubClusterQueryFilterV4' + $ref: '#/components/schemas/SiteV4N4' type: array type: object - description: Successful operation + description: Successful Operation + summary: Get Sites of Tenant (v4.4) + tags: + - Site Configuration + post: + description: Create a new site. + operationId: post-sdwan-v4.4-api-sites + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N4' + description: Details of the site to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N4' + description: Successful Operation '400': content: application/json: example: value: _error: - - code: BAD_QUERY_OR_SORT_PARAMETERS + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_SITE_CONFIG + - code: POLICY_NOT_AVAILABLE schema: $ref: '#/components/schemas/Error' - description: Bad request - summary: Query Hub Clusters (v4.0) + description: Bad Request + summary: Create a New Site (v4.4) tags: - Site Configuration - /sdwan/v4.0/api/sites/{site_id}/hubclusters: - get: - description: Get all hub clusters - operationId: get-sdwan-v4.0-api-sites-site_id-hubclusters - parameters: - - description: Site Id - in: path - name: site_id - required: true - schema: - description: Site Id - type: string + /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/ListResponse' + - $ref: '#/components/schemas/ListQueryResponse' - properties: items: items: - $ref: '#/components/schemas/HubClusterV4' + $ref: '#/components/schemas/SiteQueryFilterV4N4' type: array type: object - description: Successful operation - summary: Get all hub clusters (v4.0) + description: Successful Operation + summary: Query DB for Number of Sites that Match Query Params (v4.4) tags: - Site Configuration - post: - description: Creates a new hub cluster - operationId: post-sdwan-v4.0-api-sites-site_id-hubclusters + /sdwan/v4.4/api/sites/{site_id}: + delete: + description: Delete a particular site. + operationId: delete-sdwan-v4.4-api-sites-site_id parameters: - - description: Site Id + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. in: path name: site_id required: true schema: description: Site Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/HubClusterV4' - description: Details of the hub cluster to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubClusterV4' - description: Successful operation + $ref: '#/components/schemas/SiteV4N4' + description: Successful Operation '400': content: application/json: example: value: _error: - - code: HUB_CLUSTER_NAME_NULL_OR_EMPTY - - code: HUB_CLUSTER_NAME_EXCEEDS_LIMIT - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_TAG - - code: INVALID_HUB_SITE - - code: HUB_CLUSTER_ELEMENT_PRESENT - - code: DEFAULT_HUB_CLUSTER_EXISTS - - code: HUB_CLUSTER_NAME_NOT_UNIQUE - - code: HUB_CLUSTER_COUNT_IN_HUB_SITE_EXCEEDED - - code: DUPLICATE_SPOKE_SITES_PRESENT - - code: INVALID_PEER_SITES_PRESENT - - code: SOME_SPOKE_SITES_ALREADY_MAPPED_TO_ANOTHER_CLUSTER - - code: INVALID_VALUE_RANGE + - code: SITE_NOT_FOUND + - code: UNKNOWN_SITE + - 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: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS schema: $ref: '#/components/schemas/Error' - description: Bad request - summary: Creates a new hub cluster (v4.0) + description: Bad Request + summary: Delete a Site (v4.4) tags: - Site Configuration - /sdwan/v4.0/api/sites/{site_id}/hubclusters/{hub_cluster_id}: - delete: - description: Delete a hub cluster. - operationId: delete-sdwan-v4.0-api-sites-site_id-hubclusters-hub_cluster_id + get: + description: Get the site of a particular tenant. + operationId: get-sdwan-v4.4-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4383,76 +7509,161 @@ paths: schema: description: Site Id type: string - - description: ID of the hub cluster. + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N4' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: SITE_NOT_FOUND + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Site of Tenant (v4.4) + tags: + - Site Configuration + put: + description: Update an existing site. + operationId: put-sdwan-v4.4-api-sites-site_id + parameters: + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. in: path - name: hub_cluster_id + name: site_id required: true schema: - description: Hub Cluster Id + description: Site Id type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N4' + description: Details of the site to update + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N4' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: POLICY_CONFIG_INVALID_FOR_HUB_SITE + - code: INVALID_SECURITY_POLICYSET + - code: INVALID_POLICY_CONFIGURATION + - code: INVALID_NETWORK_POLICYSETSTACK + - code: DEFAULT_NETWORK_POLICYSETSTACK_NOT_AVAILABLE + - code: INVALID_PRIORITY_POLICYSETSTACK + - code: DEFAULT_PRIORITY_POLICYSETSTACK_NOT_AVAILABLE + - code: POLICYSETSTACK_CONFIG_NOT_SUPPORTED + - code: DEFAULT_POLICY_NOT_CONFIGURED + - code: SITE_CONFIG_SERVICEBINDING_INVALID_FOR_HUB + - code: SITE_CONFIG_SERVICEBINDING_DOES_NOT_EXIST + - code: INVALID_POLICYSET + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update a Site (v4.4) + tags: + - Site Configuration + /sdwan/v4.5/api/sites: + get: + description: Get the sites if a particular tenant. + operationId: get-sdwan-v4.5-api-sites responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubClusterV4' - description: Successful operation + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/SiteV4N5' + type: array + type: object + description: Successful Operation + summary: Get Sites of Tenant (v4.5) + tags: + - Site Configuration + post: + description: Create a new site. + operationId: post-sdwan-v4.5-api-sites + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N5' + description: Details of the site to be created + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N5' + description: Successful Operation '400': content: application/json: example: value: _error: - - code: HUB_CLUSTER_NOT_FOUND - - code: HUB_CLUSTER_HAS_ELEMENTS + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_SITE_CONFIG + - code: POLICY_NOT_AVAILABLE + - code: SITE_STATE_INVALID schema: $ref: '#/components/schemas/Error' - description: Bad request - summary: Delete Hub Cluster (v4.0) + description: Bad Request + summary: Create a New Site (v4.5) tags: - Site Configuration - get: - description: List a specific hub cluster. - operationId: get-sdwan-v4.0-api-sites-site_id-hubclusters-hub_cluster_id - parameters: - - description: ID of the site. More details on the site can be retrieved by - querying the sites API. - in: path - name: site_id - required: true - schema: - description: Site Id - type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string + /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: - $ref: '#/components/schemas/HubClusterV4' - description: Successful operation - '404': - content: - application/json: - example: - value: - _error: - - code: HUB_CLUSTER_NOT_FOUND - schema: - $ref: '#/components/schemas/Error' - description: Hub cluster not found - summary: Get Specific Hub Cluster (v4.0) + 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 - put: - description: Update the hub cluster. - operationId: put-sdwan-v4.0-api-sites-site_id-hubclusters-hub_cluster_id + /sdwan/v4.5/api/sites/{site_id}: + delete: + description: Delete a particular site. + operationId: delete-sdwan-v4.5-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4462,109 +7673,67 @@ paths: schema: description: Site Id type: string - - description: ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/HubClusterV4' - description: Details of the hub cluster to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubClusterV4' - description: Successful operation + $ref: '#/components/schemas/SiteV4N5' + description: Successful Operation '400': content: application/json: example: value: _error: - - code: HUB_CLUSTER_NAME_NULL_OR_EMPTY - - code: HUB_CLUSTER_NAME_EXCEEDS_LIMIT - - code: DESCRIPTION_EXCEEDS_LIMIT - - code: INVALID_TAG - - code: HUB_CLUSTER_NOT_FOUND - - code: DEFAULT_HUB_CLUSTER_EXISTS - - code: HUB_CLUSTER_NAME_NOT_UNIQUE - - code: HUB_CLUSTER_INVALID_ELEMENTS_INFO - - code: DUPLICATE_SPOKE_SITES_PRESENT - - code: INVALID_PEER_SITES_PRESENT - - code: SOME_SPOKE_SITES_ALREADY_MAPPED_TO_ANOTHER_CLUSTER - - code: HUB_CLUSTER_UNDER_MAINTENANCE - - code: HUB_CLUSTER_STATUS_NOT_FOUND + - code: SITE_NOT_FOUND + - code: UNKNOWN_SITE + - 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: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS schema: $ref: '#/components/schemas/Error' - description: Bad request - summary: Update Hub Cluster (v4.0) + description: Bad Request + summary: Delete a Site (v4.5) tags: - Site Configuration - /sdwan/v4.0/api/sites/{site_id}/hubclusters/{hub_cluster_id}/operations: - post: - description: The operations performed on the hub cluster. - operationId: post-sdwan-v4.0-api-sites-site_id-hubclusters-hub_cluster_id-operations + get: + description: Get the site of a particular tenant. + operationId: get-sdwan-v4.5-api-sites-site_id parameters: - - description: The ID of the site associated with the hub cluster. + - description: ID of the site. More details on the site can be retrieved by + querying the sites API. in: path name: site_id required: true schema: description: Site Id type: string - - description: The ID of the hub cluster. - in: path - name: hub_cluster_id - required: true - schema: - description: Hub Cluster Id - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/HubClusterOperationV4' - description: Details of the operations to be performed on the hub cluster. responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubClusterStatusV4' - description: Successful operation + $ref: '#/components/schemas/SiteV4N5' + description: Successful Operation '400': content: application/json: example: value: _error: - - code: HUB_CLUSTER_INVALID_OPERATION - - code: HUB_ELEMENT_ID_NULL_OR_EMPTY - - code: HUB_CLUSTER_OPERATION_SPOKE_SITES_CANNOT_BE_EMPTY - - code: HUB_CLUSTER_OR_STATUS_NOT_FOUND - - code: HUB_CLUSTER_EMPTY - - code: HUB_CLUSTER_ELEMENT_NOT_LOCKED - - code: HUB_ELEMENT_NOT_PRESENT_IN_HUB_CLUSTER - - code: HUB_CLUSTER_DOES_NOT_CATER_TO_SPECIFIED_SPOKE_SITES - - code: HUB_CLUSTER_NEW_HUB_ELEMENT_NOT_FOUND - - code: HUB_CLUSTER_ELEMENT_DOES_NOT_CATER_TO_SPECIFIED_SPOKE_SITES + - code: SITE_NOT_FOUND schema: $ref: '#/components/schemas/Error' - description: Bad request - summary: Operations Hub Cluster API (v4.0) + description: Bad Request + summary: Get Site of Tenant (v4.5) tags: - Site Configuration - /sdwan/v4.0/api/sites/{site_id}/hubclusters/{id}/status: - get: - description: Get the state of the hub cluster. - operationId: get-sdwan-v4.0-api-sites-site_id-hubclusters-id-status + put: + description: Update an existing site. + operationId: put-sdwan-v4.5-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4574,65 +7743,83 @@ paths: schema: description: Site Id type: string - - description: Hub Cluster Id - in: path - name: id - required: true - schema: - description: Id - type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SiteV4N5' + description: Details of the site to update responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HubClusterStatusV4' - description: Successful operation - '404': + $ref: '#/components/schemas/SiteV4N5' + description: Successful Operation + '400': content: application/json: + example: + value: + _error: + - code: POLICY_CONFIG_INVALID_FOR_HUB_SITE + - code: INVALID_SECURITY_POLICYSET + - code: INVALID_POLICY_CONFIGURATION + - code: INVALID_NETWORK_POLICYSETSTACK + - code: DEFAULT_NETWORK_POLICYSETSTACK_NOT_AVAILABLE + - code: INVALID_PRIORITY_POLICYSETSTACK + - code: DEFAULT_PRIORITY_POLICYSETSTACK_NOT_AVAILABLE + - code: POLICYSETSTACK_CONFIG_NOT_SUPPORTED + - code: DEFAULT_POLICY_NOT_CONFIGURED + - code: SITE_CONFIG_SERVICEBINDING_INVALID_FOR_HUB + - code: SITE_CONFIG_SERVICEBINDING_DOES_NOT_EXIST + - code: SITE_STATE_INVALID + - code: SITE_ELEMENT_CLUSTER_ROLE_UPDATE_NOT_ALLOWED + - code: INVALID_POLICYSET + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH schema: $ref: '#/components/schemas/Error' - description: Hub Cluster not found - summary: Get Hub Cluster Status (v4.0) + description: Bad Request + summary: Update a Site (v4.5) tags: - Site Configuration - /sdwan/v4.8/api/sites: + /sdwan/v4.6/api/sites: get: description: Get the sites if a particular tenant. - operationId: get-sdwan-v4.8-api-sites + operationId: get-sdwan-v4.6-api-sites responses: '200': content: application/json: schema: allOf: - - $ref: '#/components/schemas/ListResponse' + - $ref: '#/components/schemas/BulkResponse' - properties: items: items: - $ref: '#/components/schemas/SiteV4N8' + $ref: '#/components/schemas/SiteV4N6' type: array type: object description: Successful Operation - summary: Get Sites of Tenant (v4.8) + summary: Get Sites of Tenant (v4.6) tags: - Site Configuration post: description: Create a new site. - operationId: post-sdwan-v4.8-api-sites + operationId: post-sdwan-v4.6-api-sites requestBody: content: application/json: schema: - $ref: '#/components/schemas/SiteScreenV4N8' + $ref: '#/components/schemas/SiteV4N6' description: Details of the site to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteV4N8' + $ref: '#/components/schemas/SiteV4N6' description: Successful Operation '400': content: @@ -4645,44 +7832,16 @@ 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.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) + summary: Create a New Site (v4.6) tags: - Site Configuration - /sdwan/v4.8/api/sites/{site_id}: + /sdwan/v4.6/api/sites/{site_id}: delete: description: Delete a particular site. - operationId: delete-sdwan-v4.8-api-sites-site_id + operationId: delete-sdwan-v4.6-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4697,7 +7856,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N8' + $ref: '#/components/schemas/SiteV4N6' description: Successful Operation '400': content: @@ -4710,17 +7869,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_OR_ELEMENT_SHELL_EXISTS + - code: DELETE_FORBIDDEN_ELEMENT_EXISTS - code: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete a Site (v4.8) + summary: Delete a Site (v4.6) tags: - Site Configuration get: description: Get the site of a tenant by using the tenant ID and the site ID. - operationId: get-sdwan-v4.8-api-sites-site_id + operationId: get-sdwan-v4.6-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4735,7 +7894,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N8' + $ref: '#/components/schemas/SiteV4N6' description: Successful Operation '400': content: @@ -4747,12 +7906,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Site of Tenant using Tenant ID (v4.8) + summary: Get Site of Tenant using Tenant ID (v4.6) tags: - Site Configuration put: description: Update an existing site. - operationId: put-sdwan-v4.8-api-sites-site_id + operationId: put-sdwan-v4.6-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4766,14 +7925,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteScreenV4N8' + $ref: '#/components/schemas/SiteV4N6' description: Details of the site to update responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteV4N8' + $ref: '#/components/schemas/SiteV4N6' description: Successful Operation '400': content: @@ -4798,17 +7957,16 @@ 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.8) + summary: Update a Site (v4.6) tags: - Site Configuration - /sdwan/v4.9/api/sites: + /sdwan/v4.7/api/sites: get: description: Get the sites if a particular tenant. - operationId: get-sdwan-v4.9-api-sites + operationId: get-sdwan-v4.7-api-sites responses: '200': content: @@ -4819,28 +7977,28 @@ paths: - properties: items: items: - $ref: '#/components/schemas/SiteV4N9' + $ref: '#/components/schemas/SiteV4N7' type: array type: object description: Successful Operation - summary: Get Sites of Tenant (v4.9) + summary: Get Sites of Tenant (v4.7) tags: - Site Configuration post: description: Create a new site. - operationId: post-sdwan-v4.9-api-sites + operationId: post-sdwan-v4.7-api-sites requestBody: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N9' + $ref: '#/components/schemas/SiteV4N7' description: Details of the site to be created responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteScreenV4N9' + $ref: '#/components/schemas/SiteV4N7' description: Successful Operation '400': content: @@ -4854,47 +8012,16 @@ 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.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) + summary: Create a New Site (v4.7) tags: - Site Configuration - /sdwan/v4.9/api/sites/{site_id}: + /sdwan/v4.7/api/sites/{site_id}: delete: description: Delete a particular site. - operationId: delete-sdwan-v4.9-api-sites-site_id + operationId: delete-sdwan-v4.7-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4909,7 +8036,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N9' + $ref: '#/components/schemas/SiteV4N7' description: Successful Operation '400': content: @@ -4922,17 +8049,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_OR_ELEMENT_SHELL_EXISTS + - code: DELETE_FORBIDDEN_ELEMENT_EXISTS - code: SITE_CONFIG_DELETE_NOTALLOWED_SERVICEENDPOINT_EXISTS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete a Site (v4.9) + summary: Delete a Site (v4.7) tags: - Site Configuration get: description: Get the site of a tenant by using the tenant ID and the site ID. - operationId: get-sdwan-v4.9-api-sites-site_id + operationId: get-sdwan-v4.7-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4947,7 +8074,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteV4N9' + $ref: '#/components/schemas/SiteV4N7' description: Successful Operation '400': content: @@ -4959,12 +8086,12 @@ paths: schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Site of Tenant using Tenant ID (v4.9) + summary: Get Site of Tenant using Tenant ID.(v4.7) tags: - Site Configuration put: description: Update an existing site. - operationId: put-sdwan-v4.9-api-sites-site_id + operationId: put-sdwan-v4.7-api-sites-site_id parameters: - description: ID of the site. More details on the site can be retrieved by querying the sites API. @@ -4978,14 +8105,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteScreenV4N9' + $ref: '#/components/schemas/SiteV4N7' description: Details of the site to update responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SiteV4N9' + $ref: '#/components/schemas/SiteV4N7' description: Successful Operation '400': content: @@ -5011,14 +8138,10 @@ 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.9) + summary: Update a Site (v4.7) tags: - Site Configuration servers: diff --git a/openapi-specs/sdwan/unified/SoftwareManagement.yaml b/openapi-specs/sdwan/unified/SoftwareManagement.yaml index a18bd6e69..ae75978dc 100644 --- a/openapi-specs/sdwan/unified/SoftwareManagement.yaml +++ b/openapi-specs/sdwan/unified/SoftwareManagement.yaml @@ -2,21 +2,9 @@ components: schemas: Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -30,28 +18,6 @@ components: - avg - sum type: string - statistic: - description: 'The 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 BulkResponse: properties: count: @@ -68,6 +34,22 @@ components: type: description: "The type. \n" type: string + ElementImage: + properties: + id: + description: "The ID of the device images.\t\n" + type: string + release_url: + description: 'The release URL. + + ' + type: string + state: + description: "The device connection state. \n" + type: string + version: + description: "The software version installed. \n" + type: string ElementImageV2N1: properties: fips_certification_valid: @@ -410,10 +392,14 @@ components: ModelSoftwareMap: properties: bundle_name: - description: Bundle Name + description: 'The software bundle name. + + ' type: string model: - description: Model + description: 'The software model. + + ' type: string SoftwareDownloadHistoryQuery: properties: @@ -493,6 +479,49 @@ info: version: Latest openapi: 3.0.0 paths: + /sdwan/v2.0/api/element_images: + get: + description: List all the device images. + operationId: get-sdwan-v2.0-api-element_images + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/BulkResponse' + - properties: + items: + items: + $ref: '#/components/schemas/ElementImageV2N1' + type: array + type: object + description: Successful Operation + summary: Get Machine Images (v2.0) + tags: + - Software Management + /sdwan/v2.0/api/element_images/{machine_image_id}: + get: + description: List all the information about a machine image. + operationId: get-sdwan-v2.0-api-element_images-machine_image_id + parameters: + - description: The ID of the device image. + in: path + name: machine_image_id + required: true + schema: + description: Machine Image Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ElementImage' + description: Successful Operation + summary: Get Information about Machine Image (v2.0) + tags: + - Software Management /sdwan/v2.0/api/machine_upgrade/query: post: description: Query the configuration of the machine upgrade. diff --git a/openapi-specs/sdwan/unified/SystemAdministration.yaml b/openapi-specs/sdwan/unified/SystemAdministration.yaml index 567f91a32..42b1b316e 100644 --- a/openapi-specs/sdwan/unified/SystemAdministration.yaml +++ b/openapi-specs/sdwan/unified/SystemAdministration.yaml @@ -580,7 +580,6 @@ components: - SUPER - READONLY - MONITOR - - EVAL type: string username: description: 'The username. Max length = 255. @@ -611,7 +610,6 @@ components: - SUPER - READONLY - MONITOR - - EVAL type: string user_id: description: 'The element user ID. @@ -654,7 +652,6 @@ components: - SUPER - READONLY - MONITOR - - EVAL type: string username: description: 'The username. Max length = 255. @@ -755,6 +752,205 @@ components: ' type: string + Idp: + properties: + auto_provision_operators: + description: "The option Auto Create Operators is selected. True or False.\ + \ \n" + type: boolean + auto_provision_roles: + description: "The option Auto Create Operator Roles is selected. True or\ + \ False. \n" + type: boolean + disabled: + description: "List the disabled IdP configurations. \n" + type: boolean + disabled_reason: + description: 'List the reasons for disabled IdP configurations. + + ' + type: string + id: + description: 'The ID. + + ' + type: string + idp_domain_admin_email: + description: 'The entered email ID of the Palo Alto Networks Customer Support. + + ' + type: string + idp_domains: + description: 'The configured IdP domain name. Max length = 128. Consisting + of letters all in lower case and numbers only. + + ' + items: + description: Idp Domains + type: string + type: array + idp_entity_id: + description: 'The IdP identity provider ID. + + ' + type: string + idp_login_url: + description: 'The IdP login URL. + + ' + type: string + idp_logout_url: + description: 'The IdP log out URL. + + ' + type: string + idp_metadata_b64: + description: 'The IdP metadata b64. + + ' + type: string + inactive: + description: 'List the inactive IdP configurations. + + ' + type: boolean + inactive_reason: + description: 'The reason for the IdP configuration being inactive. + + ' + type: string + role_map: + description: 'Role mapping as defined in the IdP system. + + ' + type: object + session_timeout_s: + description: 'The session timeout duration for a session in seconds. The + default value is 3600 seconds. + + ' + format: int32 + type: integer + sp_metadata_b64: + description: 'The SP metadata b64. + + ' + type: string + sp_x509_b64: + description: 'sp_x509_b64. + + ' + type: string + sp_x509_serial_no: + description: 'The SP x509 serial number. Max length = 1024. + + ' + type: string + required: + - idp_entity_id + - idp_domain_admin_email + IdpV3N1: + properties: + auto_provision_operators: + description: "The option Auto Create Operators is selected. True or False.\ + \ \n" + type: boolean + auto_provision_roles: + description: "The option Auto Create Operator Roles is selected. True or\ + \ False. \n" + type: boolean + disabled: + description: "List the disabled IdP configurations. \n" + type: boolean + disabled_reason: + description: 'List the reasons for disabled IdP configurations. + + ' + type: string + id: + description: 'The ID. + + ' + type: string + idp_domain_admin_email: + description: 'The entered email ID of the Palo Alto Networks Customer Support. + + ' + type: string + idp_domains: + description: 'The configured IdP domain name. Max length = 128. Consisting + of letters all in lower case and numbers only. + + ' + items: + description: Idp Domains + type: string + type: array + idp_entity_id: + description: 'The IdP identity provider ID. + + ' + type: string + idp_login_url: + description: 'The IdP login URL. + + ' + type: string + idp_logout_url: + description: 'The IdP log out URL. + + ' + type: string + idp_metadata_b64: + description: 'The IdP metadata b64. + + ' + type: string + inactive: + description: 'List the inactive IdP configurations. + + ' + type: boolean + inactive_reason: + description: 'The reason for the IdP configuration being inactive. + + ' + type: string + role_map: + description: 'Role mapping as defined in the IdP system. + + ' + type: object + session_timeout_s: + description: 'The session timeout duration for a session in seconds. The + default value is 3600 seconds. + + ' + format: int32 + type: integer + sign_redirect_binding: + description: 'The sign redirect binding is true or false. + + ' + type: boolean + sp_metadata_b64: + description: 'The SP metadata b64. + + ' + type: string + sp_x509_b64: + description: 'sp_x509_b64. + + ' + type: string + sp_x509_serial_no: + description: 'The SP x509 serial number. Max length = 1024. + + ' + type: string + required: + - idp_entity_id + - idp_domain_admin_email IdpV3N2: properties: auto_provision_operators: @@ -1104,7 +1300,6 @@ components: ' type: string - MigrationState: {} Operator: properties: addresses: @@ -1138,12 +1333,6 @@ components: ' 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) ' - type: string email_validated: description: 'Validate the email ID. @@ -1212,9 +1401,6 @@ components: items: $ref: '#/components/schemas/LinkedAccount' type: array - migration_state: - $ref: '#/components/schemas/MigrationState' - description: Migration State name: description: "The name. \n" type: string @@ -1391,195 +1577,41 @@ components: - linked_accounts - first_name - email - OperatorV2N2: + PasswordChange: properties: - addresses: - description: 'The list of operator addresses. Max number of addresses = - 20. - - ' - items: - $ref: '#/components/schemas/Address' - type: array - custom_roles: - description: "The list/details of the custom roles. \n" - items: - $ref: '#/components/schemas/CustomRoleV2N1' - type: array - disable_idp_login: - description: "Lists if the tenant IdP log in option is disabled. \n" - type: boolean - disabled: - description: 'List the disabled tenants. - - ' - type: boolean - disabled_reason: - description: 'The reason for disabling the tenant. + oldPassword: + description: 'The old password. Max length = 1000. ' type: string - email: - description: 'The operator email ID. - - ' + password: + description: "The new password. Max length = 1000. \n" type: string - email_iam: - description: 'The operator email IAM ID. + repeatPassword: + description: 'Repeat the new password. Max length = 1000. ' type: string - email_validated: - description: 'Validate the email ID. + required: + - repeatPassword + - password + PasswordPolicy: + properties: + enable_failed_login_attempts: + description: 'The failed login attempts is enabled. ' type: boolean - enable_session_ip_lock: - description: "Enable the sessin IP lock. \n" + enable_failed_login_time_delay: + description: "The failed log in time delay is enabled. \n" type: boolean - first_name: - description: 'The first name of the operator. Max size = 100. + enable_maximum_password_length: + description: 'The maximum password length is enabled. ' - type: string - from_esp: - description: 'If the tenant is ESP. - - ' - type: boolean - from_esp_name: - description: 'The name of the ESP tenant. Max size = 512. - - ' - type: string - from_esp_tenant_id: - description: 'The ESP tenant ID. - - ' - type: string - id: - description: 'The ID. - - ' - type: string - inactive: - description: 'List the inactive tenants. - - ' - type: boolean - inactive_reason: - description: "The reason for the tenant being inactive. \n" - type: string - ipv4_list: - description: 'The list of IPv4 addresses. - - ' - items: - $ref: '#/components/schemas/IPv4Address' - type: array - is_locked: - description: 'Locked. True or False. - - ' - type: boolean - 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: 'The last name of the ESP tenant. - - ' - type: string - linked_accounts: - 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: 'The migration state. - - ' - phone_numbers: - description: 'The details of the phone numbers. Maximum of twenty phones - can be specified. - - ' - items: - $ref: '#/components/schemas/PhoneNumber' - type: array - region: - description: 'The region of the tenant. - - ' - type: string - roles: - description: "The defined ESP roles. \n" - items: - $ref: '#/components/schemas/AuthRole' - type: array - secondary_emails: - description: 'List of secondary email addresses. Max size = 20. - - ' - items: - $ref: '#/components/schemas/Email' - type: array - settings: - description: 'The operator settings. - - ' - type: string - required: - - linked_accounts - - first_name - - email - PasswordChange: - properties: - oldPassword: - description: 'The old password. Max length = 1000. - - ' - type: string - password: - description: "The new password. Max length = 1000. \n" - type: string - repeatPassword: - description: 'Repeat the new password. Max length = 1000. - - ' - type: string - required: - - repeatPassword - - password - PasswordPolicy: - properties: - enable_failed_login_attempts: - description: 'The failed login attempts is enabled. - - ' - type: boolean - enable_failed_login_time_delay: - description: "The failed log in time delay is enabled. \n" - type: boolean - enable_maximum_password_length: - description: 'The maximum password length is enabled. - - ' - type: boolean - enable_minimum_password_length: - description: 'The minimum password length is enabled. + type: boolean + enable_minimum_password_length: + description: 'The minimum password length is enabled. ' type: boolean @@ -1802,41 +1834,6 @@ 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: @@ -2117,10 +2114,7 @@ components: ' type: string - tsg_id: - description: Tsg Id - type: string - TenantV2N5: + TenantV2N1: properties: address: $ref: '#/components/schemas/Address' @@ -2136,11 +2130,6 @@ components: description: Clients type: string type: array - csp_tenant_id: - description: 'The CSP tenant ID. Max length = 32. - - ' - type: string description: description: 'The description of the tenant. Max size = 1024. @@ -2178,9 +2167,6 @@ components: ' type: boolean - is_pa_iot_security_license: - description: Is Pa Iot Security License - type: boolean is_support: description: Is Support type: boolean @@ -2216,11 +2202,6 @@ components: items: $ref: '#/components/schemas/PhoneNumber' type: array - prisma_access_tenant_id: - description: 'The prisma access tenant ID. Max size = 32. - - ' - type: string provider_data: description: 'The details of the provider data. @@ -2233,32 +2214,15 @@ components: ' type: string - sase_at: - description: 'The sase date. - - ' - format: date - type: string - telemetry_region: - description: 'The telemetry region. - - ' - type: string - tsg_id: - description: 'The tenant TSG ID. + tenant_id: + description: 'The ID of the tenant. ' type: string - tsg_instances: - description: "The details of the TSG instances. \n" - items: - $ref: '#/components/schemas/TsgInstance' - type: array - TenantV2N7: + required: + - tenant_id + TenantV2N2: properties: - ? '' - : description: X Panw Region - type: string address: $ref: '#/components/schemas/Address' description: 'The address of the site. @@ -2273,11 +2237,6 @@ components: description: Clients type: string type: array - csp_tenant_id: - description: 'The CSP tenant ID. Max length = 32. - - ' - type: string description: description: 'The description of the tenant. Max size = 1024. @@ -2313,22 +2272,10 @@ 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: 'True or False for support. - - ' + description: Is Support type: boolean name: description: 'The name of the tenant. Max size = 512. @@ -2379,77 +2326,164 @@ components: ' type: string - sase_at: - description: 'The sase date. + tenant_id: + description: 'The ID of the tenant. ' - format: date type: string - telemetry_region: - description: 'The telemetry region. + required: + - tenant_id + TenantV2N3: + properties: + address: + $ref: '#/components/schemas/Address' + description: 'The address of the site. ' + canonical_name: + description: "The tenant canonical name. Max size = 128. \n" type: string - tsg_id: - description: 'The tenant TSG ID. + clients: + description: "The client tenant. \n" + items: + description: Clients + type: string + type: array + csp_tenant_id: + description: 'The CSP tenant ID. Max length = 32. ' type: string - tsg_instances: - description: 'The details of the TSG instances. + description: + description: 'The description of the tenant. Max size = 1024. ' - items: - $ref: '#/components/schemas/TsgInstance' - type: array - Token: - properties: - oldPassword: - description: 'The old password. Max length = 1000. + disabled: + description: 'List the disabled tenants. ' type: string - password: - description: "The new password. Max length = 1000. \n" - type: string - repeatPassword: - description: 'Repeat the new password. Max length = 1000. + disabled_reason: + description: 'The reason for disabling the tenant. ' 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. + id: + description: 'The ID. ' type: string - region: - description: 'The region of the TSG instance. + inactive: + description: 'List the inactive tenants. ' type: string - Type: - properties: - value: - description: Value + inactive_reason: + description: "The reason for the tenant being inactive. \n" type: string - UserAgent: - properties: - name: - description: 'The name of the user agent. + ipv4_list: + description: "The list of IPv4 addresses. \n" + items: + $ref: '#/components/schemas/IPv4Address' + type: array + is_esp: + description: 'If the tenant is ESP. ' - type: string - UserIdentity: - properties: - disabled: + type: boolean + is_support: + description: Is Support + type: boolean + name: + description: 'The name of the tenant. Max size = 512. + + ' + type: string + operator: + $ref: '#/components/schemas/Operator' + description: 'The details of the operator. + + ' + pan_account_id: + description: 'The tenant PAN CSP account ID. Max size = 32. + + ' + type: string + pan_tenant_id: + description: 'The PAN tenant ID. Max size = 32. + + ' + type: string + password_policy: + $ref: '#/components/schemas/PasswordPolicy' + description: 'The details of the password policy. + + ' + phone_numbers: + description: 'The details of the phone numbers. + + ' + items: + $ref: '#/components/schemas/PhoneNumber' + type: array + prisma_access_tenant_id: + description: 'The prisma access tenant ID. Max size = 32. + + ' + type: string + provider_data: + description: 'The details of the provider data. + + ' + items: + $ref: '#/components/schemas/ProviderData' + type: array + region: + description: 'The region of the tenant. + + ' + type: string + telemetry_region: + description: 'The telemetry region. + + ' + type: string + Token: + properties: + oldPassword: + description: 'The old password. Max length = 1000. + + ' + type: string + 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 + 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. ' @@ -2512,6 +2546,96 @@ info: version: Latest openapi: 3.0.0 paths: + /sdwan/v2.0/api/: + get: + description: Get all the tenant information for a tenant ID. + operationId: get-sdwan-v2.0-api- + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Tenant Information (v2.0) + tags: + - System Administration + patch: + description: Patch tenant + operationId: patch-sdwan-v2.0-api- + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + description: Tenant details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: OPERATOR_INVALID_ETAG + - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Patch tenant (v2.0) + tags: + - System Administration + put: + description: Update all the tenant information for a tenant ID. + operationId: put-sdwan-v2.0-api- + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + description: Tenant details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: OPERATOR_INVALID_ETAG + - code: TENANT_INVALID_CANONICAL_NAME_CHANGE + - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Tenant Information (v2.0) + tags: + - System Administration /sdwan/v2.0/api/accounts/password/change: post: description: Allows a user to change a password. @@ -3427,18 +3551,10 @@ paths: summary: Forgot Password for Tenant Operator (v2.0) tags: - System Administration - /sdwan/v2.0/api/operators/{operator_id}/authtokens: + /sdwan/v2.0/api/operators: get: - description: List all the auth tokens. - operationId: get-sdwan-v2.0-api-operators-operator_id-authtokens - parameters: - - description: The operator ID. - in: path - name: operator_id - required: true - schema: - description: Operator Id - type: string + description: Get a list of tenant operators. + operationId: get-sdwan-v2.0-api-operators responses: '200': content: @@ -3449,36 +3565,28 @@ paths: - properties: items: items: - $ref: '#/components/schemas/AuthToken' + $ref: '#/components/schemas/OperatorV2N1' type: array type: object description: Successful Operation - summary: Get Auth Tokens (v2.0) + summary: Get Tenant Operators (v2.0) tags: - System Administration post: - description: Create an auth token. - operationId: post-sdwan-v2.0-api-operators-operator_id-authtokens - parameters: - - description: The operator ID. - in: path - name: operator_id - required: true - schema: - description: Operator Id - type: string + description: Create a tenant operator. + operationId: post-sdwan-v2.0-api-operators requestBody: content: application/json: schema: - $ref: '#/components/schemas/AuthToken' - description: Auth token details + $ref: '#/components/schemas/OperatorV2N1' + description: Operator details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/AuthToken' + $ref: '#/components/schemas/OperatorV2N1' description: Successful Operation '400': content: @@ -3486,22 +3594,21 @@ paths: example: value: _error: - - code: TOKEN_INVALID_SESSION_DATA - - code: ESP_INVALID_TENANT_DATA - - code: TOKEN_INVALID_OPERATOR_ID - - code: TOKEN_INVALID_SUBJECT_ID - - code: INVALID_EXPIRES_UTC_MS - - code: TOKEN_ACTIVE_TOKEN_EXCEEDED + - code: BAD_REQUEST + - code: SESSION_SUBJECT_NOT_FOUND + - code: OPERATOR_INVALID_OPERATOR_EMAIL + - code: OPERATOR_INVALID_SIGNUP_ROLE + - code: OPERATOR_INVALID_SUBJECT_TENANT_ID schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Auth Token (v2.0) + summary: Create Tenant Operator (v2.0) tags: - System Administration - /sdwan/v2.0/api/operators/{operator_id}/authtokens/{authtoken_id}: + /sdwan/v2.0/api/operators/{operator_id}: delete: - description: Delete an auth token. - operationId: delete-sdwan-v2.0-api-operators-operator_id-authtokens-authtoken_id + description: Delete a specific tenant operator. + operationId: delete-sdwan-v2.0-api-operators-operator_id parameters: - description: The operator ID. in: path @@ -3510,26 +3617,29 @@ paths: schema: description: Operator Id type: string - - description: The auth token ID. - in: path - name: authtoken_id - required: true - schema: - description: Authtoken Id - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/AuthToken' + $ref: '#/components/schemas/OperatorV2N1' description: Successful Operation - summary: Delete Auth Token (v2.0) + '400': + content: + application/json: + example: + value: + _error: + - code: OPERATOR_INSUFFICIENT_OPERATOR_PERMISSIONS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Delete Tenant Operator (v2.0) tags: - System Administration get: - description: Get an auth token. - operationId: get-sdwan-v2.0-api-operators-operator_id-authtokens-authtoken_id + description: List a specific tenant operator. + operationId: get-sdwan-v2.0-api-operators-operator_id parameters: - description: The operator ID. in: path @@ -3538,27 +3648,232 @@ paths: schema: description: Operator Id type: string - - description: The auth token ID. - in: path - name: authtoken_id - required: true - schema: - description: Authtoken Id - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/AuthToken' - description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - code: ESP_INVALID_TENANT_DATA + $ref: '#/components/schemas/OperatorV2N1' + description: Get an Operator + summary: Get Tenant Operator (v2.0) + tags: + - System Administration + patch: + description: Patch a tenant operator + operationId: patch-sdwan-v2.0-api-operators-operator_id + parameters: + - description: Operator Id + in: path + name: operator_id + required: true + schema: + description: Operator Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OperatorV2N1' + description: Operator details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OperatorV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + - code: OPERATOR_INVALID_OPERATOR_EMAIL + - code: OPERATOR_INVALID_ETAG + - code: OPERATOR_INVALID_SIGNUP_ROLE + - code: OPERATOR_INVALID_SUBJECT_TENANT_ID + - code: OPERATOR_INVALID_OPERATOR_ID + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Patch a tenant operator (v2.0) + tags: + - System Administration + put: + description: Update a specific tenant operator. + operationId: put-sdwan-v2.0-api-operators-operator_id + parameters: + - description: The operator ID. + in: path + name: operator_id + required: true + schema: + description: Operator Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OperatorV2N1' + description: Operator details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OperatorV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + - code: OPERATOR_INVALID_SIGNUP_ROLE + - code: OPERATOR_INVALID_SUBJECT_TENANT_ID + - code: OPERATOR_INVALID_OPERATOR_ID + - code: OPERATOR_INVALID_OPERATOR_EMAIL + - code: OPERATOR_INVALID_ETAG + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Tenant Operator (v2.0) + tags: + - System Administration + /sdwan/v2.0/api/operators/{operator_id}/authtokens: + get: + description: List all the auth tokens. + operationId: get-sdwan-v2.0-api-operators-operator_id-authtokens + parameters: + - description: The operator ID. + in: path + name: operator_id + required: true + schema: + description: Operator Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/AuthToken' + type: array + type: object + description: Successful Operation + summary: Get Auth Tokens (v2.0) + tags: + - System Administration + post: + description: Create an auth token. + operationId: post-sdwan-v2.0-api-operators-operator_id-authtokens + parameters: + - description: The operator ID. + in: path + name: operator_id + required: true + schema: + description: Operator Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthToken' + description: Auth token details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthToken' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TOKEN_INVALID_SESSION_DATA + - code: ESP_INVALID_TENANT_DATA + - code: TOKEN_INVALID_OPERATOR_ID + - code: TOKEN_INVALID_SUBJECT_ID + - code: INVALID_EXPIRES_UTC_MS + - code: TOKEN_ACTIVE_TOKEN_EXCEEDED + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Create Auth Token (v2.0) + tags: + - System Administration + /sdwan/v2.0/api/operators/{operator_id}/authtokens/{authtoken_id}: + delete: + description: Delete an auth token. + operationId: delete-sdwan-v2.0-api-operators-operator_id-authtokens-authtoken_id + parameters: + - description: The operator ID. + in: path + name: operator_id + required: true + schema: + description: Operator Id + type: string + - description: The auth token ID. + in: path + name: authtoken_id + required: true + schema: + description: Authtoken Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthToken' + description: Successful Operation + summary: Delete Auth Token (v2.0) + tags: + - System Administration + get: + description: Get an auth token. + operationId: get-sdwan-v2.0-api-operators-operator_id-authtokens-authtoken_id + parameters: + - description: The operator ID. + in: path + name: operator_id + required: true + schema: + description: Operator Id + type: string + - description: The auth token ID. + in: path + name: authtoken_id + required: true + schema: + description: Authtoken Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthToken' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: ESP_INVALID_TENANT_DATA - code: TOKEN_INVALID_OPERATOR_ID schema: $ref: '#/components/schemas/Error' @@ -4130,36 +4445,6 @@ 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. @@ -4398,31 +4683,16 @@ paths: summary: Update User Identity (v2.0) tags: - System Administration - /sdwan/v2.1/api/clients/{client_id}/roles: + /sdwan/v2.1/api/: get: - description: List all the client custom roles. - operationId: get-sdwan-v2.1-api-clients-client_id-roles - parameters: - - description: The client ID. - in: path - name: client_id - required: true - schema: - description: Client Id - type: string + description: Get all the tenant information for a tenant ID. + operationId: get-sdwan-v2.1-api- responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/CustomRoleV2N1' - type: array - type: object + $ref: '#/components/schemas/TenantV2N1' description: Successful Operation '400': content: @@ -4430,7 +4700,112 @@ paths: example: value: _error: - - code: TENANT_INVALID_TENANT_ID + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Tenant Information (v2.1) + tags: + - System Administration + patch: + description: Patch tenant + operationId: patch-sdwan-v2.1-api- + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TenantV2N1' + description: Tenant details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TenantV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: OPERATOR_INVALID_ETAG + - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Patch tenant (v2.1) + tags: + - System Administration + put: + description: Update all the tenant information for a tenant ID. + operationId: put-sdwan-v2.1-api- + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TenantV2N1' + description: Tenant details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TenantV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: OPERATOR_INVALID_ETAG + - code: TENANT_INVALID_CANONICAL_NAME_CHANGE + - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update Tenant Information (v2.1) + tags: + - System Administration + /sdwan/v2.1/api/clients/{client_id}/roles: + get: + description: List all the client custom roles. + operationId: get-sdwan-v2.1-api-clients-client_id-roles + parameters: + - description: The client ID. + in: path + name: client_id + required: true + schema: + description: Client Id + type: string + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/CustomRoleV2N1' + type: array + type: object + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_INVALID_TENANT_ID - code: ESP_CLIENT_ID_INVALID schema: $ref: '#/components/schemas/Error' @@ -4902,7 +5277,7 @@ paths: - System Administration /sdwan/v2.1/api/operators/{operator_id}: delete: - description: Delete a specific tenant operator. + description: Delete a tenant operator. operationId: delete-sdwan-v2.1-api-operators-operator_id parameters: - description: The operator ID. @@ -4934,7 +5309,7 @@ paths: tags: - System Administration get: - description: List a specific tenant operator. + description: Get a tenant operator. operationId: get-sdwan-v2.1-api-operators-operator_id parameters: - description: The operator ID. @@ -4954,8 +5329,54 @@ paths: summary: Get Tenant Operator (v2.1) tags: - System Administration + patch: + description: Patch a tenant operator. + operationId: patch-sdwan-v2.1-api-operators-operator_id + parameters: + - description: The operator ID. + in: path + name: operator_id + required: true + schema: + description: Operator Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OperatorV2N1' + description: Operator details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OperatorV2N1' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: BAD_REQUEST + - code: OPERATOR_INVALID_OPERATOR_EMAIL + - code: OPERATOR_INVALID_ETAG + - code: OPERATOR_INVALID_SIGNUP_ROLE + - code: OPERATOR_INVALID_SUBJECT_TENANT_ID + - code: OPERATOR_INVALID_OPERATOR_ID + - code: OPERATOR_INVALID_OPERATOR_MULTIPLE_SYSTEM_ROLE + - code: OPERATOR_INVALID_OPERATOR_SYSTEM_ROLE + - code: OPERATOR_CAN_NOT_ASSIGN_SYSTEM_GENERATED_CUSTOM_ROLE + - code: OPERATOR_INVALID_CANNOT_SET_READONLY_FIELDS + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Patch Tenant Operator (v2.1) + tags: + - System Administration put: - description: Update a specific tenant operator. + description: Update a tenant operator. operationId: put-sdwan-v2.1-api-operators-operator_id parameters: - description: The operator ID. @@ -5445,42 +5866,46 @@ paths: summary: Update Custom Role (v2.1) tags: - System Administration - /sdwan/v2.2/api/operators: + /sdwan/v2.2/api/: get: - description: Get a list of tenant operators. - operationId: get-sdwan-v2.2-api-operators + description: Get all the tenant information for a tenant ID. + operationId: get-sdwan-v2.2-api- responses: '200': content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListResponse' - - properties: - items: - items: - $ref: '#/components/schemas/OperatorV2N2' - type: array - type: object + $ref: '#/components/schemas/TenantV2N2' description: Successful Operation - summary: Get Tenant Operators (v2.2) + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Tenant Information (v2.2) tags: - System Administration - post: - description: Create a tenant operator. - operationId: post-sdwan-v2.2-api-operators + patch: + description: Patch tenant + operationId: patch-sdwan-v2.2-api- requestBody: content: application/json: schema: - $ref: '#/components/schemas/OperatorV2N2' - description: Operator details + $ref: '#/components/schemas/TenantV2N2' + description: Tenant details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/OperatorV2N2' + $ref: '#/components/schemas/TenantV2N2' description: Successful Operation '400': content: @@ -5488,39 +5913,31 @@ paths: example: value: _error: - - code: BAD_REQUEST - - code: OPERATOR_INVALID_OPERATOR_EMAIL - - code: SESSION_SUBJECT_NOT_FOUND - - code: OPERATOR_INVALID_SIGNUP_ROLE - - code: OPERATOR_INVALID_SUBJECT_TENANT_ID - - code: OPERATOR_INVALID_OPERATOR_MULTIPLE_SYSTEM_ROLE - - code: OPERATOR_INVALID_OPERATOR_SYSTEM_ROLE - - code: OPERATOR_CAN_NOT_ASSIGN_SYSTEM_GENERATED_CUSTOM_ROLE - - code: OPERATOR_INVALID_CANNOT_SET_READONLY_FIELDS + - code: OPERATOR_INVALID_ETAG + - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Create Tenant Operator (v2.2) + summary: Patch tenant (v2.2) tags: - System Administration - /sdwan/v2.2/api/operators/{operator_id}: - delete: - description: Delete a specific tenant operator. - operationId: delete-sdwan-v2.2-api-operators-operator_id - parameters: - - description: The operator ID. - in: path - name: operator_id - required: true - schema: - description: Operator Id - type: string + put: + description: Update all the tenant information for a tenant ID. + operationId: put-sdwan-v2.2-api- + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TenantV2N2' + description: Tenant details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/OperatorV2N2' + $ref: '#/components/schemas/TenantV2N2' description: Successful Operation '400': content: @@ -5528,58 +5945,89 @@ paths: example: value: _error: - - code: OPERATOR_INVALID_SIGNUP_ROLE - - code: OPERATOR_DELETE_INVALID_ROLE_SYSTEM + - code: OPERATOR_INVALID_ETAG + - code: TENANT_INVALID_CANONICAL_NAME_CHANGE + - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete Tenant Operator (v2.2) + summary: Update Tenant Information (v2.2) tags: - System Administration + /sdwan/v2.3/api/: get: - description: List a specific tenant operator. - operationId: get-sdwan-v2.2-api-operators-operator_id - parameters: - - description: The operator ID. - in: path - name: operator_id - required: true - schema: - description: Operator Id - type: string + description: Get all the tenant information for a tenant ID. + operationId: get-sdwan-v2.3-api- + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TenantV2N3' + description: Successful Operation + '400': + content: + application/json: + example: + value: + _error: + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get Tenant Information (v2.3) + tags: + - System Administration + patch: + description: Patch tenant + operationId: patch-sdwan-v2.3-api- + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TenantV2N3' + description: Tenant details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/OperatorV2N2' + $ref: '#/components/schemas/TenantV2N3' description: Successful Operation - summary: Get Tenant Operator (v2.2) + '400': + content: + application/json: + example: + value: + _error: + - code: OPERATOR_INVALID_ETAG + - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Patch tenant (v2.3) tags: - System Administration put: - description: Update a specific tenant operator. - operationId: put-sdwan-v2.2-api-operators-operator_id - parameters: - - description: The operator ID. - in: path - name: operator_id - required: true - schema: - description: Operator Id - type: string + description: Update all the tenant information for a tenant ID. + operationId: put-sdwan-v2.3-api- requestBody: content: application/json: schema: - $ref: '#/components/schemas/OperatorV2N2' - description: Operator details + $ref: '#/components/schemas/TenantV2N3' + description: Tenant details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/OperatorV2N2' + $ref: '#/components/schemas/TenantV2N3' description: Successful Operation '400': content: @@ -5587,32 +6035,53 @@ paths: example: value: _error: - - code: BAD_REQUEST - - code: OPERATOR_INVALID_SIGNUP_ROLE - - code: OPERATOR_INVALID_SUBJECT_TENANT_ID - - code: OPERATOR_INVALID_OPERATOR_ID - - code: OPERATOR_INVALID_OPERATOR_EMAIL - code: OPERATOR_INVALID_ETAG - - code: OPERATOR_INVALID_OPERATOR_MULTIPLE_SYSTEM_ROLE - - code: OPERATOR_INVALID_OPERATOR_SYSTEM_ROLE - - code: OPERATOR_CAN_NOT_ASSIGN_SYSTEM_GENERATED_CUSTOM_ROLE - - code: OPERATOR_INVALID_CANNOT_SET_READONLY_FIELDS + - code: TENANT_INVALID_CANONICAL_NAME_CHANGE + - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT + - code: TENANT_INVALID_CLIENT_ID + - code: ESP_INVALID_CLIENT_DATA schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update Tenant Operator (v2.2) + summary: Update Tenant Information (v2.3) tags: - System Administration - /sdwan/v2.6/api/: + /sdwan/v3.0/api/idps: get: - description: Get tenant details for a tenant ID. - operationId: get-sdwan-v2.6-api- + description: List all the configured IdPs. + operationId: get-sdwan-v3.0-api-idps responses: '200': content: application/json: schema: - $ref: '#/components/schemas/TenantV2N5' + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/Idp' + type: array + type: object + description: Successful Operation + summary: Get IDPs (v3.0) + tags: + - System Administration + post: + description: Create an IDP. + operationId: post-sdwan-v3.0-api-idps + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Idp' + description: Idp details + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Idp' description: Successful Operation '400': content: @@ -5620,29 +6089,79 @@ paths: example: value: _error: - - code: TENANT_INVALID_CLIENT_ID - - code: ESP_INVALID_CLIENT_DATA + - code: BAD_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Tenant Details for Tenant ID (v2.6) + summary: Create an IDP (v3.0) + tags: + - System Administration + /sdwan/v3.0/api/idps/{idp_id}: + delete: + description: Delete a specific IDP. + operationId: delete-sdwan-v3.0-api-idps-idp_id + parameters: + - description: The IdP ID. + in: path + name: idp_id + required: true + schema: + description: Idp Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Idp' + description: Successful Operation + summary: Delete an IDP (v3.0) + tags: + - System Administration + get: + description: List a specific IDP. + operationId: get-sdwan-v3.0-api-idps-idp_id + parameters: + - description: The IdP ID. + in: path + name: idp_id + required: true + schema: + description: Idp Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Idp' + description: Successful Operation + summary: Get an IDP (v3.0) tags: - System Administration put: - description: Update a tenant. - operationId: put-sdwan-v2.6-api- + description: Update SSO. + operationId: put-sdwan-v3.0-api-idps-idp_id + parameters: + - description: The SSO ID. + in: path + name: idp_id + required: true + schema: + description: Idp Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TenantV2N5' - description: Tenant details + $ref: '#/components/schemas/Idp' + description: Sso details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/TenantV2N5' + $ref: '#/components/schemas/Idp' description: Successful Operation '400': content: @@ -5650,27 +6169,49 @@ paths: example: value: _error: - - code: OPERATOR_INVALID_ETAG - - code: TENANT_INVALID_CANONICAL_NAME_CHANGE - - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT - - code: TENANT_INVALID_CLIENT_ID - - code: ESP_INVALID_CLIENT_DATA + - code: SSO_INVALID_ETAG schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update a tenant (v2.6) + summary: Update SSO (v3.0) tags: - System Administration - /sdwan/v2.7/api/: + /sdwan/v3.1/api/idps: get: - description: Get tenant details for a tenant ID. - operationId: get-sdwan-v2.7-api- + description: List all the configured IdPs. + operationId: get-sdwan-v3.1-api-idps + responses: + '200': + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ListResponse' + - properties: + items: + items: + $ref: '#/components/schemas/IdpV3N1' + type: array + type: object + description: Successful Operation + summary: Get IDPs (v3.1) + tags: + - System Administration + post: + description: Create an IDP. + operationId: post-sdwan-v3.1-api-idps + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IdpV3N1' + description: Idp details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/TenantV2N7' + $ref: '#/components/schemas/IdpV3N1' description: Successful Operation '400': content: @@ -5678,29 +6219,79 @@ paths: example: value: _error: - - code: TENANT_INVALID_CLIENT_ID - - code: ESP_INVALID_CLIENT_DATA + - code: BAD_REQUEST schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Get Tenant Details for Tenant ID (v2.7) + summary: Create an IDP (v3.1) + tags: + - System Administration + /sdwan/v3.1/api/idps/{idp_id}: + delete: + description: Delete a specific IDP. + operationId: delete-sdwan-v3.1-api-idps-idp_id + parameters: + - description: The IdP ID. + in: path + name: idp_id + required: true + schema: + description: Idp Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IdpV3N1' + description: Successful Operation + summary: Delete an IDP (v3.1) + tags: + - System Administration + get: + description: List a specific IDP. + operationId: get-sdwan-v3.1-api-idps-idp_id + parameters: + - description: The IdP ID. + in: path + name: idp_id + required: true + schema: + description: Idp Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IdpV3N1' + description: Successful Operation + summary: Get an IDP (v3.1) tags: - System Administration put: - description: Update a tenant. - operationId: put-sdwan-v2.7-api- + description: Update SSO. + operationId: put-sdwan-v3.1-api-idps-idp_id + parameters: + - description: The SSO ID. + in: path + name: idp_id + required: true + schema: + description: Idp Id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TenantV2N7' - description: Tenant details + $ref: '#/components/schemas/IdpV3N1' + description: Sso details responses: '200': content: application/json: schema: - $ref: '#/components/schemas/TenantV2N7' + $ref: '#/components/schemas/IdpV3N1' description: Successful Operation '400': content: @@ -5708,15 +6299,11 @@ paths: example: value: _error: - - code: OPERATOR_INVALID_ETAG - - code: TENANT_INVALID_CANONICAL_NAME_CHANGE - - code: TENANT_PASSWORD_AGING_PREVENT_LOCKOUT - - code: TENANT_INVALID_CLIENT_ID - - code: ESP_INVALID_CLIENT_DATA + - code: SSO_INVALID_ETAG schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Update a tenant (v2.7) + summary: Update SSO (v3.1) 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 983460951..78eee4b2e 100644 --- a/openapi-specs/sdwan/unified/Topology.yaml +++ b/openapi-specs/sdwan/unified/Topology.yaml @@ -34,21 +34,9 @@ components: type: string Aggregate: properties: - data: - description: 'The details of the aggregate data. - - ' - items: - $ref: '#/components/schemas/AggregateData' - type: array field: description: 'The field value. - ' - type: string - name: - description: 'The name of the query response. - ' type: string operator: @@ -62,28 +50,155 @@ components: - avg - sum type: string - statistic: - description: 'The aggregate statistics. - - ' + AnynetLinkV2: + properties: + ep1_site_id: + description: Ep1 Site Id type: string - unit: - description: 'The unit. - - ' + 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 + id: + description: Id + type: string + type: + description: Type + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE type: string - AggregateData: + AnynetLinkV3: properties: - value: - description: 'Value of the aggregate data. - - ' - type: number - view: - description: 'View the aggregate date. - - ' - type: object + admin_up: + description: Admin Up + type: boolean + 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: Id + type: string + type: + description: Type + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + AnynetLinkV3N1: + properties: + admin_up: + description: Admin Up + type: boolean + description: + description: Description + type: string + 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: Id + type: string + name: + description: Name + type: string + tags: + description: Tags + items: + description: Tags + type: string + type: array + type: + description: Type + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + AnynetLinkV3N2: + properties: + admin_up: + description: Admin Up + type: boolean + description: + description: Description + type: string + 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: Id + type: string + name: + description: Name + type: string + tags: + description: Tags + items: + description: Tags + type: string + type: array + type: + description: Type + enum: + - AUTO + - MANUAL + - AUTO_PRIVATE + - MANUAL_PRIVATE + - AUTO_SASE + type: string + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: 'Vpnlink Configuration: Valid ' AnynetLinkV3N3: properties: admin_up: @@ -519,182 +634,307 @@ components: ' type: string - NetworkLinkV3N3: + NetworkLinkV3: properties: admin_up: - description: 'The interface admin state. - - ' + description: Admin Up type: boolean anynet_link_id: - description: 'The anynet link ID.. - - ' + description: 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. - - ' + description: Elem Interface Id type: string element_id: - description: 'The element ID. - - ' + description: Element Id type: string id: - description: 'The ID. - - ' + description: 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. - - ' + description: Source Circuit Name type: string source_node_id: - description: 'The source node ID. - - ' + description: Source Node Id type: string source_site_name: - description: 'The source site name. - - ' + description: Source Site Name type: string source_wan_if_id: - description: 'The source WAN ID. - - ' + description: Source Wan If Id type: string source_wan_network: - description: 'The source WAN network. - - ' + description: Source Wan Network type: string source_wan_nw_id: - description: 'The The source WAN network ID. - - ' + description: Source Wan Nw Id type: string status: - description: 'The status of the link. - - ' + description: Status 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. - - ' + description: Target Circuit Name type: string target_node_id: - description: 'The target node ID. - - ' + description: Target Node Id type: string target_site_name: - description: 'The target site name. - - ' + description: Target Site Name type: string target_wan_if_id: - description: 'The target WAN ID. - - ' + description: Target Wan If Id type: string target_wan_network: - description: 'The target WAN network. - - ' + description: Target Wan Network type: string target_wan_nw_id: - description: 'The The target WAN network ID. - - ' + description: Target Wan Nw Id type: string type: - description: 'Anynet link type. - - ' + description: Type type: string - vpnlink_configuration: - $ref: '#/components/schemas/VPNLinkConfiguration' - description: 'The configuration of the VPN link. - - ' vpnlinks: - description: 'The VPN links info. - - ' + description: Vpnlinks items: description: Vpnlinks type: string type: array wan_if_id: - description: 'The WAN ID. - - ' + description: Wan If Id type: string wan_nw_id: - description: 'The WAN network ID. - - ' + description: Wan Nw Id type: string wan_nw_name: - description: 'The WAN network name. - - ' + description: Wan Nw Name type: string - NetworkLinkV3N4: + NetworkLinkV3N1: + properties: + admin_up: + description: Admin Up + type: boolean + anynet_link_id: + description: Anynet Link Id + type: string + description: + description: Description + type: string + elem_interface_id: + description: Elem Interface Id + type: string + element_id: + description: Element Id + type: string + id: + description: Id + type: string + in_use: + description: In Use + type: boolean + name: + description: Name + type: string + network: + description: Network + type: string + path_id: + description: Path Id + type: string + sep_name: + description: Sep Name + type: string + source_circuit_name: + description: Source Circuit Name + type: string + source_node_id: + description: Source Node Id + type: string + source_site_name: + description: Source Site Name + type: string + source_wan_if_id: + description: Source Wan If Id + type: string + source_wan_network: + description: Source Wan Network + type: string + source_wan_nw_id: + description: Source Wan Nw Id + type: string + status: + description: Status + type: string + sub_type: + description: Sub Type + type: string + tags: + description: Tags + items: + description: Tags + type: string + type: array + target_circuit_name: + description: Target Circuit Name + type: string + target_node_id: + description: Target Node Id + type: string + target_site_name: + description: Target Site Name + type: string + target_wan_if_id: + description: Target Wan If Id + type: string + target_wan_network: + description: Target Wan Network + type: string + target_wan_nw_id: + description: Target Wan Nw Id + type: string + type: + description: Type + type: string + vpnlinks: + description: Vpnlinks + items: + description: Vpnlinks + type: string + type: array + wan_if_id: + description: Wan If Id + type: string + wan_nw_id: + description: Wan Nw Id + type: string + wan_nw_name: + description: Wan Nw Name + type: string + NetworkLinkV3N2: + properties: + admin_up: + description: Admin Up + type: boolean + anynet_link_id: + description: Anynet Link Id + type: string + description: + description: Description + type: string + elem_interface_id: + description: Elem Interface Id + type: string + element_id: + description: Element Id + type: string + id: + description: Id + type: string + in_use: + description: In Use + type: boolean + name: + description: Name + type: string + network: + description: Network + type: string + path_id: + description: Path Id + type: string + sep_name: + description: Sep Name + type: string + source_circuit_name: + description: Source Circuit Name + type: string + source_elem_if_id: + description: Source Elem If Id + type: string + source_node_id: + description: Source Node Id + type: string + source_site_name: + description: Source Site Name + type: string + source_wan_if_id: + description: Source Wan If Id + type: string + source_wan_network: + description: Source Wan Network + type: string + source_wan_nw_id: + description: Source Wan Nw Id + type: string + status: + description: Status + type: string + sub_type: + description: Sub Type + type: string + tags: + description: Tags + items: + description: Tags + type: string + type: array + target_circuit_name: + description: Target Circuit Name + type: string + target_elem_if_id: + description: Target Elem If Id + type: string + target_node_id: + description: Target Node Id + type: string + target_site_name: + description: Target Site Name + type: string + target_wan_if_id: + description: Target Wan If Id + type: string + target_wan_network: + description: Target Wan Network + type: string + target_wan_nw_id: + description: Target Wan Nw Id + type: string + type: + description: Type + type: string + vpnlink_configuration: + $ref: '#/components/schemas/VPNLinkConfiguration' + description: Vpnlink Configuration + vpnlinks: + description: Vpnlinks + items: + description: Vpnlinks + type: string + type: array + wan_if_id: + description: Wan If Id + type: string + wan_nw_id: + description: Wan Nw Id + type: string + wan_nw_name: + description: Wan Nw Name + type: string + NetworkLinkV3N3: properties: admin_up: description: 'The interface admin state. @@ -816,12 +1056,6 @@ components: ' 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. @@ -871,79 +1105,320 @@ components: ' type: string wan_nw_name: - description: "The WAN network name. \n" + description: 'The WAN network name. + + ' type: string - NetworkNode: + NetworkLinkV3N4: properties: - address: - $ref: '#/components/schemas/Address' - description: 'The network address details. + admin_up: + description: 'The interface admin state. ' - elem_hw_id: - description: 'The element hardware ID. + type: boolean + anynet_link_id: + description: 'The anynet link ID.. ' type: string - id: - description: 'The ID. + 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 - location: - $ref: '#/components/schemas/Location' - description: 'The network node location. + element_id: + description: 'The element ID. + + ' + type: string + id: + description: 'The ID. ' + type: string + in_use: + description: In Use + type: boolean name: - description: 'The network name. Max size = 128. + description: 'The anynet link name. Max size = 128. ' type: string - role: - description: Role + network: + description: Network type: string - site_id: - description: "The site ID. \n" + path_id: + description: Path Id type: string - spoke_cluster_elem_status: - description: "The spoke cluster element status. \n" + sep_id: + description: Sep Id type: string - state: - description: State + sep_name: + description: Sep Name type: string - type: - description: 'Anynet link type. + source_circuit_name: + description: 'The name of the source circuit. ' type: string - NetworkTopologyV3N3: - properties: - links: - description: 'Query the anynet links. + source_elem_if_id: + description: 'The source element ID. ' - items: - $ref: '#/components/schemas/NetworkLinkV3N3' - type: array - nodes: - description: Nodes - items: - $ref: '#/components/schemas/NetworkNode' - type: array - type: - description: 'Anynet link type. + type: string + source_node_id: + description: 'The source node ID. ' - enum: - - ANYNET - - ANYNETPLUS - - BASENET - - PHYSICAL type: string - NetworkTopologyV3N4: - properties: - links: + 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: '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" + 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. \n" + type: string + state: + description: State + type: string + type: + description: 'Anynet link type. + + ' + type: string + NetworkTopologyV3: + properties: + links: + description: Links + items: + $ref: '#/components/schemas/NetworkLinkV3' + type: array + nodes: + description: Nodes + items: + $ref: '#/components/schemas/NetworkNode' + type: array + type: + description: Type + enum: + - ANYNET + - ANYNETPLUS + - BASENET + - PHYSICAL + type: string + NetworkTopologyV3N1: + properties: + links: + description: Links + items: + $ref: '#/components/schemas/NetworkLinkV3N1' + type: array + nodes: + description: Nodes + items: + $ref: '#/components/schemas/NetworkNode' + type: array + type: + description: Type + enum: + - ANYNET + - ANYNETPLUS + - BASENET + - PHYSICAL + type: string + NetworkTopologyV3N2: + properties: + links: + description: Links + items: + $ref: '#/components/schemas/NetworkLinkV3N2' + type: array + nodes: + description: Nodes + items: + $ref: '#/components/schemas/NetworkNode' + type: array + type: + description: Type + enum: + - ANYNET + - ANYNETPLUS + - BASENET + - PHYSICAL + 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. ' @@ -981,6 +1456,40 @@ components: start: $ref: '#/components/schemas/Location' description: Start + TopologyQuery: + properties: + links: + description: Links + items: + description: Links + type: string + type: array + links_only: + description: Links Only + type: boolean + location: + $ref: '#/components/schemas/SiteLocation' + description: Location + nodes: + description: Nodes + items: + description: Nodes + type: string + type: array + site_id: + description: Site Id + type: string + sites: + $ref: '#/components/schemas/SiteEndpoints' + description: Sites + type: + description: Type + enum: + - ANYNET + - ANYNETPLUS + - BASENET + - PHYSICAL + type: string TopologyQueryV3N1: properties: links: @@ -1276,6 +1785,109 @@ info: version: Latest openapi: 3.0.0 paths: + /sdwan/v2.0/api/anynetlinks: + post: + description: Create anynet link + operationId: post-sdwan-v2.0-api-anynetlinks + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV2' + 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 (v2.0) + tags: + - Topology + /sdwan/v2.0/api/anynetlinks/{anynet_id}: + delete: + description: Delete anynet link + operationId: delete-sdwan-v2.0-api-anynetlinks-anynet_id + parameters: + - description: 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 (v2.0) + tags: + - Topology + put: + description: update anynet link + operationId: put-sdwan-v2.0-api-anynetlinks-anynet_id + parameters: + - description: Anynet Id + in: path + name: anynet_id + required: true + schema: + description: Anynet Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV2' + 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 (v2.0) + tags: + - Topology /sdwan/v2.0/api/sites/{site_id}/anynetlinks/{anynet_id}: get: description: Get the anynet link. @@ -1321,14 +1933,574 @@ paths: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ListQueryResponse' - - properties: - items: - items: - $ref: '#/components/schemas/VPNLinkQuery' - type: array - type: object + 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 + /sdwan/v2.0/api/vpnlinks/{vpn_link_id}/operations: + post: + description: Perform an operation on a VPN link. + operationId: post-sdwan-v2.0-api-vpnlinks-vpn_link_id-operations + parameters: + - 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 + /sdwan/v2.0/api/vpnlinks/{vpn_link_id}/state: + get: + description: List the admin state of the VPN link. + operationId: get-sdwan-v2.0-api-vpnlinks-vpn_link_id-state + parameters: + - 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-sdwan-v2.0-api-vpnlinks-vpn_link_id-state + parameters: + - 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 + /sdwan/v2.0/api/vpnlinks/{vpn_link_id}/status: + get: + description: List the status of the VPN link. + operationId: get-sdwan-v2.0-api-vpnlinks-vpn_link_id-status + parameters: + - 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 + /sdwan/v2.0/api/wanoverlays: + get: + description: List the app/wan contexts. + operationId: get-sdwan-v2.0-api-wanoverlays + 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-sdwan-v2.0-api-wanoverlays + 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 + /sdwan/v2.0/api/wanoverlays/{wan_overlay_id}: + delete: + description: Create a new app/wan context. + operationId: delete-sdwan-v2.0-api-wanoverlays-wan_overlay_id + parameters: + - 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-sdwan-v2.0-api-wanoverlays-wan_overlay_id + parameters: + - 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: APPWAN_CONTEXT_DOES_NOT_EXIST + - code: APPWAN_CONTEXT_NAME_INVALID + - code: APPWAN_CONTEXT_DESCRIPTION_INVALID + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Get App/WAN Context (v2.0) + tags: + - Topology + put: + description: Update a new app/wan context. + operationId: put-sdwan-v2.0-api-wanoverlays-wan_overlay_id + parameters: + - 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/WanOverlay' + description: Details of the appwan context to be updated + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WanOverlay' + description: Successful Operation + '400': + content: + application/json: + 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_EXTRA_ATTRIBUTE + - code: INVALID_JSON_COMMON_ATTR_MISMATCH + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + summary: Update App/WAN Context (v2.0) + tags: + - Topology + /sdwan/v2.1/api/vpnlinks/{vpn_link_id}/status: + get: + description: List the status of the VPN link. + operationId: get-sdwan-v2.1-api-vpnlinks-vpn_link_id-status + parameters: + - 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/VPLStatusV2N1' + 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.1) + tags: + - Topology + /sdwan/v3.0/api/anynetlinks: + post: + description: Create anynet link + operationId: post-sdwan-v3.0-api-anynetlinks + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV3' + 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.0) + tags: + - Topology + /sdwan/v3.0/api/anynetlinks/{anynet_id}: + delete: + description: Delete anynet link + operationId: delete-sdwan-v3.0-api-anynetlinks-anynet_id + parameters: + - description: 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.0) + tags: + - Topology + get: + description: GET anynet link + operationId: get-sdwan-v3.0-api-anynetlinks-anynet_id + parameters: + - description: Anynet Id + in: path + name: anynet_id + required: true + schema: + description: Anynet Id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkLinkV3' + description: Successful Operation + '404': + description: not found + summary: GET anynet link (v3.0) + tags: + - Topology + put: + description: Update anynet link + operationId: put-sdwan-v3.0-api-anynetlinks-anynet_id + parameters: + - description: Anynet Id + in: path + name: anynet_id + required: true + schema: + description: Anynet Id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV3' + 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.0) + 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.0/api/topology: + post: + description: Query topology + operationId: post-sdwan-v3.0-api-topology + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TopologyQuery' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkTopologyV3' + 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.0) + tags: + - Topology + /sdwan/v3.1/api/anynetlinks: + post: + description: Create anynet link + operationId: post-sdwan-v3.1-api-anynetlinks + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnynetLinkV3N1' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Anynetlink' description: Successful Operation '400': content: @@ -1336,37 +2508,33 @@ paths: example: value: _error: - - code: VPL_NOT_FOUND - - code: VPL_ACTION_INSUFFICIENT_VPE + - code: INVALID_JSON_INPUT + - code: INVALID_JSON_EXTRA_ATTRIBUTE + - code: TOPOLOGY_REBUILD_IN_PROGRESS schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Query DB for VPN Links (v2.0) + summary: Create anynet link (v3.1) tags: - Topology - /sdwan/v2.0/api/vpnlinks/{vpn_link_id}/operations: - post: - description: Perform an operation on a VPN link. - operationId: post-sdwan-v2.0-api-vpnlinks-vpn_link_id-operations + /sdwan/v3.1/api/anynetlinks/{anynet_id}: + delete: + description: Delete anynet link + operationId: delete-sdwan-v3.1-api-anynetlinks-anynet_id parameters: - - description: The ID of the VPN link. + - description: Anynet Id in: path - name: vpn_link_id + name: anynet_id required: true schema: - description: Vpn Link Id + description: Anynet Id type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VPLOperationsScreen' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VPLOperations' + $ref: '#/components/schemas/Anynetlink' description: Successful Operation '400': content: @@ -1374,70 +2542,60 @@ paths: example: value: _error: - - code: VPL_NOT_FOUND - - code: VPL_ACTION_INSUFFICIENT_VPE - - code: VPNLINK_INVALID_ACTION + - code: TOPOLOGY_REBUILD_IN_PROGRESS + - code: NO_ANYNETLINK_FOUND + - code: INVALID_ANYNETLINK_TYPE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Perform Operation on VPN Link (v2.0) + summary: Delete anynet link (v3.1) tags: - Topology - /sdwan/v2.0/api/vpnlinks/{vpn_link_id}/state: get: - description: List the admin state of the VPN link. - operationId: get-sdwan-v2.0-api-vpnlinks-vpn_link_id-state + description: GET anynet link + operationId: get-sdwan-v3.1-api-anynetlinks-anynet_id parameters: - - description: The ID of the VPN link. + - description: 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/VPLAdminState' + $ref: '#/components/schemas/NetworkLinkV3N1' 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) + '404': + description: not found + summary: GET anynet link (v3.1) tags: - Topology put: - description: Update the admin state of the VPN link. - operationId: put-sdwan-v2.0-api-vpnlinks-vpn_link_id-state + description: Update anynet link + operationId: put-sdwan-v3.1-api-anynetlinks-anynet_id parameters: - - description: The ID of the VPN link. + - description: Anynet Id in: path - name: vpn_link_id + name: anynet_id required: true schema: - description: Vpn Link Id + description: Anynet Id type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/VPLAdminState' + $ref: '#/components/schemas/AnynetLinkV3N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VPLAdminState' + $ref: '#/components/schemas/Anynetlink' description: Successful Operation '400': content: @@ -1445,34 +2603,30 @@ 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: Update anynet link (v3.1) tags: - Topology - /sdwan/v2.0/api/vpnlinks/{vpn_link_id}/status: - get: - description: List the status of the VPN link. - operationId: get-sdwan-v2.0-api-vpnlinks-vpn_link_id-status - parameters: - - description: The ID of the VPN link. - in: path - name: vpn_link_id - required: true - schema: - description: Vpn Link Id - type: string + /sdwan/v3.1/api/topology: + post: + description: Query topology + operationId: post-sdwan-v3.1-api-topology + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TopologyQueryV3N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VPLStatus' + $ref: '#/components/schemas/NetworkTopologyV3N1' description: Successful Operation '400': content: @@ -1480,50 +2634,32 @@ 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.0) - tags: - - Topology - /sdwan/v2.0/api/wanoverlays: - get: - description: List the app/wan contexts. - operationId: get-sdwan-v2.0-api-wanoverlays - 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) + summary: Query topology (v3.1) tags: - Topology + /sdwan/v3.2/api/anynetlinks: post: - description: Create a new app/wan context. - operationId: post-sdwan-v2.0-api-wanoverlays + description: Create anynet link + operationId: post-sdwan-v3.2-api-anynetlinks requestBody: content: application/json: schema: - $ref: '#/components/schemas/WanOverlay' - description: Details of the appwan context to be created + $ref: '#/components/schemas/AnynetLinkV3N2' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WanOverlay' + $ref: '#/components/schemas/Anynetlink' description: Successful Operation '400': content: @@ -1531,37 +2667,33 @@ 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: Create anynet link (v3.2) tags: - Topology - /sdwan/v2.0/api/wanoverlays/{wan_overlay_id}: + /sdwan/v3.2/api/anynetlinks/{anynet_id}: delete: - description: Create a new app/wan context. - operationId: delete-sdwan-v2.0-api-wanoverlays-wan_overlay_id + description: Delete anynet link + operationId: delete-sdwan-v3.2-api-anynetlinks-anynet_id parameters: - - description: The ID of the WAN overlay. + - description: 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: @@ -1569,69 +2701,60 @@ paths: example: value: _error: - - code: WANOVERLAY_IN_USE + - code: TOPOLOGY_REBUILD_IN_PROGRESS + - code: NO_ANYNETLINK_FOUND + - code: INVALID_ANYNETLINK_TYPE schema: $ref: '#/components/schemas/Error' description: Bad Request - summary: Delete App/WAN Context (v2.0) + summary: Delete anynet link (v3.2) tags: - Topology get: - description: List the new app/wan context. - operationId: get-sdwan-v2.0-api-wanoverlays-wan_overlay_id + description: GET anynet link + operationId: get-sdwan-v3.2-api-anynetlinks-anynet_id parameters: - - description: The ID of the WAN overlay. + - description: 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/NetworkLinkV3N2' description: Successful Operation - '400': - content: - application/json: - example: - value: - _error: - - 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: Get App/WAN Context (v2.0) + '404': + description: not found + summary: GET anynet link (v3.2) tags: - Topology put: - description: Update a new app/wan context. - operationId: put-sdwan-v2.0-api-wanoverlays-wan_overlay_id + description: Update anynet link + operationId: put-sdwan-v3.2-api-anynetlinks-anynet_id parameters: - - description: The ID of the WAN overlay. + - description: 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/AnynetLinkV3N2' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/WanOverlay' + $ref: '#/components/schemas/Anynetlink' description: Successful Operation '400': content: @@ -1639,38 +2762,30 @@ 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.2) tags: - Topology - /sdwan/v2.1/api/vpnlinks/{vpn_link_id}/status: - get: - description: List the status of the VPN link. - operationId: get-sdwan-v2.1-api-vpnlinks-vpn_link_id-status - parameters: - - description: The ID of the VPN link. - in: path - name: vpn_link_id - required: true - schema: - description: Vpn Link Id - type: string + /sdwan/v3.2/api/topology: + post: + description: Query topology + operationId: post-sdwan-v3.2-api-topology + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TopologyQueryV3N1' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/VPLStatusV2N1' + $ref: '#/components/schemas/NetworkTopologyV3N2' description: Successful Operation '400': content: @@ -1678,41 +2793,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) - 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) + summary: Query topology (v3.2) tags: - Topology /sdwan/v3.3/api/anynetlinks: