{ "components": { "schemas": { "ProviderData": { "properties": { "certificate": { "description": "Certificate", "$ref": "#/components/schemas/CertificateCa" }, "security": { "type": "string", "description": "Security" }, "password_hash": { "type": "string", "description": "Password Hash" }, "salt": { "type": "string", "description": "Salt" }, "provider": { "description": "Provider", "$ref": "#/components/schemas/Provider" } } }, "ListResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "CustomPermission": { "properties": { "disallow_permission": { "type": "boolean", "description": "Disallow Permission" }, "allowed_before_ms": { "type": "integer", "description": "Allowed Before Ms", "format": "int64" }, "allowed_after_ms": { "type": "integer", "description": "Allowed After Ms", "format": "int64" }, "value": { "type": "string", "description": "Value: Pattern(error = INVALID_PERMISSION_VALUE: Permission value contains invalid characters. Check data {}, regexp = ^[/0-9a-zA-+_\\\\[\\\\]-]{1,500}$) NotEmpty " }, "region": { "type": "string", "description": "Region" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "boolean", "description": "Disabled" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "boolean", "description": "Inactive" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string" } }, "required": [ "value" ] }, "Type": { "properties": { "value": { "type": "string", "description": "Value" } } }, "ProfileV2N1": { "properties": { "session_id": { "type": "string", "description": "Session Id" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "Session": { "properties": { "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "boolean", "description": "Inactive" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "boolean", "description": "Disabled" }, "expires": { "type": "string", "format": "date" }, "user_agent": { "description": "User Agent", "$ref": "#/components/schemas/UserAgent" }, "type": { "type": "string", "description": "Type" }, "client_ip": { "type": "string", "description": "Client Ip" }, "session_key_c": { "type": "string", "description": "Session Key C: Length(max = 128, , min = 0) " }, "operator_id": { "type": "string", "description": "Operator Id" }, "id": { "type": "string", "description": "Id" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" } } }, "TenantCacheQueryFilter": { "properties": { "region": { "type": "string", "description": "Region" }, "telemetry_region": { "type": "string", "description": "Telemetry Region" }, "tsg_id": { "type": "string", "description": "Tsg Id" }, "clients": { "type": "array", "description": "Clients", "items": { "type": "string", "description": "Clients" } }, "is_esp": { "type": "boolean", "description": "Is Esp" }, "name": { "type": "string", "description": "Name" }, "canonical_name": { "type": "string", "description": "Canonical Name" }, "id": { "type": "string", "description": "Id" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" } } }, "CustomRole": { "properties": { "inactive": { "type": "boolean", "description": "Inactive" }, "disabled": { "type": "boolean", "description": "Disabled" }, "custom_permissions": { "type": "array", "description": "Custom Permissions", "items": { "$ref": "#/components/schemas/CustomPermission" } }, "disallow_permissions": { "type": "array", "description": "Disallow Permissions", "items": { "$ref": "#/components/schemas/AuthPermission" } }, "permissions": { "type": "array", "description": "Permissions", "items": { "$ref": "#/components/schemas/AuthPermission" } }, "roles": { "type": "array", "description": "Roles", "items": { "$ref": "#/components/schemas/AuthRole" } }, "id": { "type": "string", "description": "Id" }, "name": { "type": "string", "description": "Name: Pattern(AUTH_ROLE_INVALID, regexp = (guest|system|element|support_iam_admin|support_admin|support_viewonly|support_mfg|support_super|support_root|devops|secops|tenant_iam_admin|tenant_network_admin|tenant_security_admin|tenant_viewonly|tenant_super|tenant_root|esp_iam_admin|esp_machine_admin|esp_admin|esp_user|esp_super|esp_root)) NotBlank " } }, "required": [ "name" ] }, "TenantV2N11": { "properties": { "device_id_enabled": { "type": "boolean", "description": "Device Id Enabled" }, "is_sase_edge": { "type": "boolean", "description": "Is Sase Edge" }, "app_acceleration_enabled": { "type": "boolean", "description": "App Acceleration Enabled" }, "adem_enabled": { "type": "boolean", "description": "Adem Enabled" }, "": { "type": "string", "description": "X Panw Region" }, "is_oneapp_ready": { "type": "boolean", "description": "Is Oneapp Ready" }, "is_pa_iot_security_license": { "type": "boolean", "description": "Is Pa Iot Security License" }, "tsg_instances": { "type": "array", "description": "Tsg Instances: Valid ", "items": { "$ref": "#/components/schemas/TsgInstance" } }, "sase_at": { "type": "string", "format": "date" }, "tsg_id": { "type": "string", "description": "Tsg Id: Length(max = 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support, min = 0) Digits(fraction = 0, integer = 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support) " }, "csp_tenant_id": { "type": "string", "description": "Csp Tenant Id: Length(max = 32, TENANT_INVALID_CSP_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_CSP_IT_TENANT_ID) " }, "telemetry_region": { "type": "string", "description": "Telemetry Region" }, "prisma_access_tenant_id": { "type": "string", "description": "Prisma Access Tenant Id: Length(max = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID) " }, "pan_tenant_id": { "type": "string", "description": "Pan Tenant Id: Length(max = 32, TENANT_INVALID_PAN_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PAN_IT_TENANT_ID) " }, "pan_account_id": { "type": "string", "description": "Pan Account Id: Length(max = 32, TENANT_INVALID_PAN_CSP_ACCOUNT_ID, min = 0) " }, "region": { "type": "string", "description": "Region" }, "clients": { "type": "array", "description": "Clients: Valid ", "items": { "type": "string", "description": "Clients" } }, "is_support": { "type": "boolean", "description": "Is Support" }, "is_esp": { "type": "boolean", "description": "Is Esp" }, "provider_data": { "type": "array", "description": "Provider Data: Valid ", "items": { "$ref": "#/components/schemas/ProviderData" } }, "operator": { "description": "Operator", "$ref": "#/components/schemas/Operator" }, "password_policy": { "description": "Password Policy: Valid ", "$ref": "#/components/schemas/PasswordPolicy" }, "ipv4_list": { "type": "array", "description": "Ipv4 List: Valid ", "items": { "$ref": "#/components/schemas/IPv4Address" } }, "phone_numbers": { "type": "array", "description": "Phone Numbers: Valid ", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "address": { "description": "Address: Valid ", "$ref": "#/components/schemas/Address" }, "description": { "type": "string", "description": "Description: Length(max = 1024, error = TENANT_INVALID_DESCRIPTION: Please provide a description with a length less than 1024 characters, min = 0) " }, "name": { "type": "string", "description": "Name: Length(max = 512, error = TENANT_INVALID_NAME: Please provide a valid name with a length less than 512 characters, min = 0) " }, "canonical_name": { "type": "string", "description": "Canonical Name: Pattern(error = TENANT_INVALID_CANONICAL_NAME: Please provide a valid canonical name with a length less than 128 characters, e.g., mydomain.com, regexp = [0-9a-zA-Z\\\\.\\\\-_]{1,128}) " }, "id": { "type": "string", "description": "Id" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "string", "description": "Inactive" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "string", "description": "Disabled" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" } } }, "TenantV2N10": { "properties": { "is_sase_edge": { "type": "boolean", "description": "Is Sase Edge" }, "app_acceleration_enabled": { "type": "boolean", "description": "App Acceleration Enabled" }, "adem_enabled": { "type": "boolean", "description": "Adem Enabled" }, "": { "type": "string", "description": "X Panw Region" }, "is_oneapp_ready": { "type": "boolean", "description": "Is Oneapp Ready" }, "is_pa_iot_security_license": { "type": "boolean", "description": "Is Pa Iot Security License" }, "tsg_instances": { "type": "array", "description": "Tsg Instances: Valid ", "items": { "$ref": "#/components/schemas/TsgInstance" } }, "sase_at": { "type": "string", "format": "date" }, "tsg_id": { "type": "string", "description": "Tsg Id: Length(max = 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support, min = 0) Digits(fraction = 0, integer = 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support) " }, "csp_tenant_id": { "type": "string", "description": "Csp Tenant Id: Length(max = 32, TENANT_INVALID_CSP_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_CSP_IT_TENANT_ID) " }, "telemetry_region": { "type": "string", "description": "Telemetry Region" }, "prisma_access_tenant_id": { "type": "string", "description": "Prisma Access Tenant Id: Length(max = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID) " }, "pan_tenant_id": { "type": "string", "description": "Pan Tenant Id: Length(max = 32, TENANT_INVALID_PAN_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PAN_IT_TENANT_ID) " }, "pan_account_id": { "type": "string", "description": "Pan Account Id: Length(max = 32, TENANT_INVALID_PAN_CSP_ACCOUNT_ID, min = 0) " }, "region": { "type": "string", "description": "Region" }, "clients": { "type": "array", "description": "Clients: Valid ", "items": { "type": "string", "description": "Clients" } }, "is_support": { "type": "boolean", "description": "Is Support" }, "is_esp": { "type": "boolean", "description": "Is Esp" }, "provider_data": { "type": "array", "description": "Provider Data: Valid ", "items": { "$ref": "#/components/schemas/ProviderData" } }, "operator": { "description": "Operator", "$ref": "#/components/schemas/Operator" }, "password_policy": { "description": "Password Policy: Valid ", "$ref": "#/components/schemas/PasswordPolicy" }, "ipv4_list": { "type": "array", "description": "Ipv4 List: Valid ", "items": { "$ref": "#/components/schemas/IPv4Address" } }, "phone_numbers": { "type": "array", "description": "Phone Numbers: Valid ", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "address": { "description": "Address: Valid ", "$ref": "#/components/schemas/Address" }, "description": { "type": "string", "description": "Description: Length(max = 1024, error = TENANT_INVALID_DESCRIPTION: Please provide a description with a length less than 1024 characters, min = 0) " }, "name": { "type": "string", "description": "Name: Length(max = 512, error = TENANT_INVALID_NAME: Please provide a valid name with a length less than 512 characters, min = 0) " }, "canonical_name": { "type": "string", "description": "Canonical Name: Pattern(error = TENANT_INVALID_CANONICAL_NAME: Please provide a valid canonical name with a length less than 128 characters, e.g., mydomain.com, regexp = [0-9a-zA-Z\\\\.\\\\-_]{1,128}) " }, "id": { "type": "string", "description": "Id" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "string", "description": "Inactive" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "string", "description": "Disabled" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" } } }, "Idp": { "properties": { "auto_provision_roles": { "type": "boolean", "description": "Auto Provision Roles" }, "auto_provision_operators": { "type": "boolean", "description": "Auto Provision Operators" }, "session_timeout_s": { "type": "integer", "description": "Session Timeout S: Range(max = 2147483646L, error = SSO_INVALID_SESSION_TIMEOUT_SEC: Invalid range {validatedValue}. Please use a range between 180 to 2147483646 inclusive, min = 180L) ", "format": "int32" }, "role_map": { "type": "object" }, "sp_metadata_b64": { "type": "string", "description": "Sp Metadata B64: Length(max = 1000000, error = SSO_INVALID_SP_METADATA_B64: Invalid size for service provide metadata, min = 1) " }, "sp_x509_b64": { "type": "string", "description": "Sp X509 B64: Length(max = 100000, error = SSO_INVALID_SP_X509_B64: Invalid size for service provide x509 cert, min = 1) " }, "sp_x509_serial_no": { "type": "string", "description": "Sp X509 Serial No: Length(max = 1024, error = SSO_INVALID_SP_X509_SERIAL_NO: Invalid size for service provide x509 serial no, min = 1) " }, "idp_metadata_b64": { "type": "string", "description": "Idp Metadata B64: Length(max = 1000000, error = SSO_INVALID_IDP_METADATA_B64: Invalid size for IdP metadata, min = 1) " }, "idp_logout_url": { "type": "string", "description": "Idp Logout Url: Length(max = 2048, error = SSO_INVALID_IDP_LOGOUT_URL: Invalid size for logout url, min = 1) " }, "idp_login_url": { "type": "string", "description": "Idp Login Url: Length(max = 2048, error = SSO_INVALID_IDP_SSO_URL: Invalid size for IdP single sign on Url, min = 1) " }, "idp_entity_id": { "type": "string", "description": "Idp Entity Id: Length(max = 2048, error = SSO_INVALID_IDP_ENTITY_ID: Invalid size for entity id in metadata, min = 1) NotEmpty(error = SSO_EMPTY_IDP_ENTITY_ID: Provide entity id for IdP) " }, "idp_domain_admin_email": { "type": "string", "description": "Idp Domain Admin Email: Length(max = 1024, error = SSO_INVALID_IDP_DOMAIN_ADMIN_EMAIL: Provide a valid admin email for IdP domain, min = 1) NotEmpty(error = SSO_EMPTY_IDP_DOMAIN_ADMIN_EMAIL: Provide an admin email for IdP) " }, "idp_domains": { "type": "array", "description": "Idp Domains: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 128, listMaxSize = 100, error = SSO_INVALID_IDP_EMAIL_DOMAIN: Provide valid and unique IdP domain(s), all in lowercase and consist of letters and numbers only, noTrim = false, regex = [0-9a-z._-]+, required = false) ", "items": { "type": "string", "description": "Idp Domains" } }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "boolean", "description": "Disabled" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "boolean", "description": "Inactive" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "idp_entity_id", "idp_domain_admin_email" ] }, "Provider": { "properties": { "map_external_group": { "type": "object" }, "template": { "type": "string", "description": "Template" }, "protocol": { "description": "Protocol", "$ref": "#/components/schemas/Protocol" }, "description": { "type": "string", "description": "Description" }, "name": { "type": "string", "description": "Name" }, "canonical_name": { "type": "string", "description": "Canonical Name" }, "region": { "type": "string", "description": "Region" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "boolean", "description": "Disabled" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "boolean", "description": "Inactive" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string" } } }, "PhoneNumber": { "properties": { "types": { "type": "array", "description": "Types", "items": { "$ref": "#/components/schemas/Type" } }, "local_extension": { "type": "integer", "description": "Local Extension", "format": "int32" }, "number": { "type": "integer", "description": "Number", "format": "int64" }, "country_code": { "type": "integer", "description": "Country Code", "format": "int32" } } }, "TenantV2N13": { "properties": { "is_native_prisma_enabled": { "type": "boolean", "description": "Is Native Prisma Enabled" }, "is_sls_enabled": { "type": "boolean", "description": "Is Sls Enabled" }, "is_branch_security_enabled": { "type": "boolean", "description": "Is Branch Security Enabled" }, "device_id_enabled": { "type": "boolean", "description": "Device Id Enabled" }, "is_sase_edge": { "type": "boolean", "description": "Is Sase Edge" }, "app_acceleration_enabled": { "type": "boolean", "description": "App Acceleration Enabled" }, "adem_enabled": { "type": "boolean", "description": "Adem Enabled" }, "": { "type": "string", "description": "X Panw Region" }, "is_oneapp_ready": { "type": "boolean", "description": "Is Oneapp Ready" }, "is_pa_iot_security_license": { "type": "boolean", "description": "Is Pa Iot Security License" }, "tsg_instances": { "type": "array", "description": "Tsg Instances: Valid ", "items": { "$ref": "#/components/schemas/TsgInstance" } }, "sase_at": { "type": "string", "format": "date" }, "tsg_id": { "type": "string", "description": "Tsg Id: Length(max = 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support, min = 0) Digits(fraction = 0, integer = 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support) " }, "csp_tenant_id": { "type": "string", "description": "Csp Tenant Id: Length(max = 32, TENANT_INVALID_CSP_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_CSP_IT_TENANT_ID) " }, "telemetry_region": { "type": "string", "description": "Telemetry Region" }, "prisma_access_tenant_id": { "type": "string", "description": "Prisma Access Tenant Id: Length(max = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID) " }, "pan_tenant_id": { "type": "string", "description": "Pan Tenant Id: Length(max = 32, TENANT_INVALID_PAN_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PAN_IT_TENANT_ID) " }, "pan_account_id": { "type": "string", "description": "Pan Account Id: Length(max = 32, TENANT_INVALID_PAN_CSP_ACCOUNT_ID, min = 0) " }, "region": { "type": "string", "description": "Region" }, "clients": { "type": "array", "description": "Clients: Valid ", "items": { "type": "string", "description": "Clients" } }, "is_support": { "type": "boolean", "description": "Is Support" }, "is_esp": { "type": "boolean", "description": "Is Esp" }, "provider_data": { "type": "array", "description": "Provider Data: Valid ", "items": { "$ref": "#/components/schemas/ProviderData" } }, "operator": { "description": "Operator", "$ref": "#/components/schemas/Operator" }, "password_policy": { "description": "Password Policy: Valid ", "$ref": "#/components/schemas/PasswordPolicy" }, "ipv4_list": { "type": "array", "description": "Ipv4 List: Valid ", "items": { "$ref": "#/components/schemas/IPv4Address" } }, "phone_numbers": { "type": "array", "description": "Phone Numbers: Valid ", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "address": { "description": "Address: Valid ", "$ref": "#/components/schemas/Address" }, "description": { "type": "string", "description": "Description: Length(max = 1024, error = TENANT_INVALID_DESCRIPTION: Please provide a description with a length less than 1024 characters, min = 0) " }, "name": { "type": "string", "description": "Name: Length(max = 512, error = TENANT_INVALID_NAME: Please provide a valid name with a length less than 512 characters, min = 0) " }, "canonical_name": { "type": "string", "description": "Canonical Name: Pattern(error = TENANT_INVALID_CANONICAL_NAME: Please provide a valid canonical name with a length less than 128 characters, e.g., mydomain.com, regexp = [0-9a-zA-Z\\\\.\\\\-_]{1,128}) " }, "id": { "type": "string", "description": "Id" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "string", "description": "Inactive" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "string", "description": "Disabled" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" } } }, "PasswordChange": { "properties": { "repeatPassword": { "type": "string", "description": "RepeatPassword: MinLength(message = minLength, value = 1L) MaxLength(message = maxLength, value = 1000L) Required(message = required) " }, "password": { "type": "string", "description": "Password: MinLength(message = minLength, value = 1L) MaxLength(message = maxLength, value = 1000L) Required(message = required) " }, "oldPassword": { "type": "string", "description": "OldPassword: MinLength(message = minLength, value = 1L) MaxLength(message = maxLength, value = 1000L) " } }, "required": [ "repeatPassword", "password" ] }, "TenantV2N12": { "properties": { "is_sls_enabled": { "type": "boolean", "description": "Is Sls Enabled" }, "is_branch_security_enabled": { "type": "boolean", "description": "Is Branch Security Enabled" }, "device_id_enabled": { "type": "boolean", "description": "Device Id Enabled" }, "is_sase_edge": { "type": "boolean", "description": "Is Sase Edge" }, "app_acceleration_enabled": { "type": "boolean", "description": "App Acceleration Enabled" }, "adem_enabled": { "type": "boolean", "description": "Adem Enabled" }, "": { "type": "string", "description": "X Panw Region" }, "is_oneapp_ready": { "type": "boolean", "description": "Is Oneapp Ready" }, "is_pa_iot_security_license": { "type": "boolean", "description": "Is Pa Iot Security License" }, "tsg_instances": { "type": "array", "description": "Tsg Instances: Valid ", "items": { "$ref": "#/components/schemas/TsgInstance" } }, "sase_at": { "type": "string", "format": "date" }, "tsg_id": { "type": "string", "description": "Tsg Id: Length(max = 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support, min = 0) Digits(fraction = 0, integer = 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support) " }, "csp_tenant_id": { "type": "string", "description": "Csp Tenant Id: Length(max = 32, TENANT_INVALID_CSP_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_CSP_IT_TENANT_ID) " }, "telemetry_region": { "type": "string", "description": "Telemetry Region" }, "prisma_access_tenant_id": { "type": "string", "description": "Prisma Access Tenant Id: Length(max = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID) " }, "pan_tenant_id": { "type": "string", "description": "Pan Tenant Id: Length(max = 32, TENANT_INVALID_PAN_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PAN_IT_TENANT_ID) " }, "pan_account_id": { "type": "string", "description": "Pan Account Id: Length(max = 32, TENANT_INVALID_PAN_CSP_ACCOUNT_ID, min = 0) " }, "region": { "type": "string", "description": "Region" }, "clients": { "type": "array", "description": "Clients: Valid ", "items": { "type": "string", "description": "Clients" } }, "is_support": { "type": "boolean", "description": "Is Support" }, "is_esp": { "type": "boolean", "description": "Is Esp" }, "provider_data": { "type": "array", "description": "Provider Data: Valid ", "items": { "$ref": "#/components/schemas/ProviderData" } }, "operator": { "description": "Operator", "$ref": "#/components/schemas/Operator" }, "password_policy": { "description": "Password Policy: Valid ", "$ref": "#/components/schemas/PasswordPolicy" }, "ipv4_list": { "type": "array", "description": "Ipv4 List: Valid ", "items": { "$ref": "#/components/schemas/IPv4Address" } }, "phone_numbers": { "type": "array", "description": "Phone Numbers: Valid ", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "address": { "description": "Address: Valid ", "$ref": "#/components/schemas/Address" }, "description": { "type": "string", "description": "Description: Length(max = 1024, error = TENANT_INVALID_DESCRIPTION: Please provide a description with a length less than 1024 characters, min = 0) " }, "name": { "type": "string", "description": "Name: Length(max = 512, error = TENANT_INVALID_NAME: Please provide a valid name with a length less than 512 characters, min = 0) " }, "canonical_name": { "type": "string", "description": "Canonical Name: Pattern(error = TENANT_INVALID_CANONICAL_NAME: Please provide a valid canonical name with a length less than 128 characters, e.g., mydomain.com, regexp = [0-9a-zA-Z\\\\.\\\\-_]{1,128}) " }, "id": { "type": "string", "description": "Id" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "string", "description": "Inactive" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "string", "description": "Disabled" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" } } }, "MigrationState": {}, "CertificateIssuer": { "properties": { "country": { "type": "string", "description": "Country: Length(max = 100, , min = 0) " }, "state": { "type": "string", "description": "State: Length(max = 100, , min = 0) " }, "location": { "type": "string", "description": "Location: Length(max = 100, , min = 0) " }, "organization": { "type": "string", "description": "Organization: Length(max = 100, , min = 0) " }, "organization_unit": { "type": "string", "description": "Organization Unit: Length(max = 100, , min = 0) " }, "common_name": { "type": "string", "description": "Common Name: Length(max = 100, , min = 0) " } } }, "ExtensionQueryFilter": { "properties": { "conf": { "type": "object" }, "disabled": { "type": "boolean", "description": "Disabled" }, "namespace": { "type": "string", "description": "Namespace: NotEmpty(error = EXTENSION_NAMESPACE_REQD: Provide valid {} attribute) Pattern(error = INVALID_EXTENSION_NAMESPACE: Provide valid {} attribute. Invalid value {}, regexp = ^[a-z][a-z0-9/]*[a-z0-9]+$) " }, "name": { "type": "string", "description": "Name: NotEmpty(error = EXTENSION_NAME_REQD: Provide valid {} attribute) Size(max = 128, error = INVALID_EXTENSION_NAME: Provide valid {} attribute. Invalid value {}, min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "conf", "namespace", "name" ] }, "CustomRoleV2N1": { "properties": { "region": { "type": "string", "description": "Region" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "boolean", "description": "Inactive" }, "disabled": { "type": "boolean", "description": "Disabled" }, "is_system_owned": { "type": "boolean", "description": "Is System Owned" }, "custom_permissions": { "type": "array", "description": "Custom Permissions: Size(max = 100, error = AUTH_ROLE_INVALID_CUSTOM_PERMISSIONS_SIZE: Custom permissions set is limited to 100, min = 0) ", "items": { "$ref": "#/components/schemas/CustomPermission" } }, "disallow_permissions": { "type": "array", "description": "Disallow Permissions: Valid Size(max = 100, error = AUTH_ROLE_INVALID_DISALLOW_PERMISSION_LIST_SIZE: Disallowed ermissions set is limited to 100, min = 0) ", "items": { "$ref": "#/components/schemas/AuthPermission" } }, "permissions": { "type": "array", "description": "Permissions: Valid Size(max = 100, error = AUTH_ROLE_INVALID_PERMISSION_LIST_SIZE: Permissions set is limited to 100, min = 0) ", "items": { "$ref": "#/components/schemas/AuthPermission" } }, "description": { "type": "string", "description": "Description: Size(max = 1000, error = AUTH_ROLE_INVALID_ROLE_DESCRIPTION: Description size is limited to {} length, min = 1) " }, "roles": { "type": "array", "description": "Roles: Valid Size(max = 7, error = AUTH_ROLE_INVALID_ROLE_LIST_SIZE: Roles set size is limited to {} length, min = 0) ", "items": { "$ref": "#/components/schemas/AuthRole" } }, "name": { "type": "string", "description": "Name: Size(max = 256, error = AUTH_ROLE_INVALID_ROLE_NAME: Auth role name comprises of lowercase and underscore characters only, min = 1) NotEmpty " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "UserAgent": { "properties": { "name": { "type": "string", "description": "Name" } } }, "IPv4Address": { "properties": { "ipv4": { "type": "string", "description": "Ipv4: IPv4(INVALID_IPV4_0001, regexp = [/0-9.]*) " } } }, "ClientPermissions": { "properties": { "settings": { "type": "string", "description": "Settings: Size(max = 100000, error = ESP_OPERATOR_INVALID_SETTINGS_SIZE: Invalid data size for settings. Maximum of 100KB data size is allowed, min = 0) " }, "custom_roles": { "type": "array", "description": "Custom Roles: Size(max = 100, error = ESP_OPERATOR_INVALID_CUSTOM_ROLES_LIST_SIZE: Custom roles set is limited to {} length, min = 0) ", "items": { "$ref": "#/components/schemas/CustomRole" } }, "roles": { "type": "array", "description": "Roles: Valid Size(max = 7, error = ESP_OPERATOR_ROLE_LIST_INVALID: Invalid role list, min = 0) ", "items": { "$ref": "#/components/schemas/AuthRole" } }, "enable_session_ip_lock": { "type": "boolean", "description": "Enable Session Ip Lock" }, "ipv4_list": { "type": "array", "description": "Ipv4 List: Size(max = 100, error = ESP_IPV4_INVALID: Invalid ipv4 list, min = 0) Valid ", "items": { "$ref": "#/components/schemas/IPv4Address" } }, "name": { "type": "string", "description": "Name: Size(max = 100, error = ESP_OPERATOR_NAME_INVALID: Invalid operator name, min = 0) " }, "email": { "type": "string", "description": "Email: Email(error = ESP_OPERATOR_EMAIL_INVALID: Invalid operator email, regexp = .*) Size(max = 1000, error = ESP_OPERATOR_EMAIL_INVALID: Invalid operator email, min = 0) " }, "client_id": { "type": "string", "description": "Client Id: NotNull Digits(fraction = 0, integer = 20, error = ESP_CLIENT_ID_INVALID: Invalid client id) " }, "operator_id": { "type": "string", "description": "Operator Id: NotNull Digits(fraction = 0, integer = 20, error = ESP_OPERATOR_ID_INVALID: Invalid operator id) " }, "region": { "type": "string", "description": "Region" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "boolean", "description": "Disabled" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "boolean", "description": "Inactive" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string" } }, "required": [ "client_id", "operator_id" ] }, "Login": { "properties": { "logout_others": { "type": "boolean", "description": "Logout Others" }, "requestId": { "type": "string", "description": "RequestId: MinLength(message = minLength, value = 1L) MaxLength(message = maxLength, value = 200L) " }, "password": { "type": "string", "description": "Password: MinLength(message = minLength, value = 1L) MaxLength(message = maxLength, value = 1000L) " }, "email": { "type": "string", "description": "Email: Email(message = email) MaxLength(message = maxLength, value = 1000L) " } } }, "AuthToken": { "properties": { "expires_utc_ms": { "type": "integer", "description": "Expires Utc Ms", "format": "int64" }, "x_auth_token": { "type": "string", "description": "X Auth Token" }, "session_key_c": { "type": "string", "description": "Session Key C: Length(max = 128, , min = 0) " }, "custom_roles": { "type": "array", "description": "Custom Roles: Size(max = 100, error = SESSION_INVALID_CUSTOM_ROLES_LIST_SIZE: Custom permissions set is limited to {} length, min = 0) ", "items": { "$ref": "#/components/schemas/CustomRole" } }, "roles": { "type": "array", "description": "Roles: Valid Size(max = 7, error = SESSION_INVALID_ROLE_LIST_SIZE: Roles set size is limited to {} length, min = 0) ", "items": { "$ref": "#/components/schemas/AuthRole" } }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "ApiVersions": { "properties": { "api_versions": { "type": "object" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "api_versions" ] }, "Address": { "properties": { "country": { "type": "string", "description": "Country: Length(max = 100, , min = 0) " }, "post_code": { "type": "string", "description": "Post Code: Length(max = 100, , min = 0) " }, "state": { "type": "string", "description": "State: Length(max = 100, , min = 0) " }, "city": { "type": "string", "description": "City: Length(max = 100, , min = 0) " }, "street2": { "type": "string", "description": "Street2: Length(max = 100, , min = 0) " }, "street": { "type": "string", "description": "Street: Length(max = 100, , min = 0) " } } }, "AuthPermission": { "properties": { "value": { "type": "string", "description": "Value: Size(max = 500, PERMISSION_INVALID_0001, min = 0) " } } }, "Email": { "properties": { "email": { "type": "string", "description": "Email: Email(EMAIL_INVALID_0001, regexp = .*) Size(max = 1000, EMAIL_INVALID_0002, min = 1) " } } }, "BaseQueryDTO": { "properties": { "last_query_ts": { "type": "integer", "description": "Last Query Ts", "format": "int64" }, "getDeleted": { "type": "boolean", "description": "GetDeleted" }, "aggregate": { "description": "Aggregate", "$ref": "#/components/schemas/Aggregate" }, "group_by": { "type": "array", "description": "Group By", "items": { "type": "string", "description": "Group By" } }, "retrieved_fields": { "type": "array", "description": "Retrieved Fields", "items": { "type": "string", "description": "Retrieved Fields" } }, "retrieved_fields_mask": { "type": "boolean", "description": "Retrieved Fields Mask" }, "total_count": { "type": "integer", "description": "Total Count", "format": "int64" }, "dest_page": { "type": "integer", "description": "Dest Page", "format": "int32" }, "next_query": { "type": "object" }, "limit": { "type": "integer", "description": "Limit", "format": "int32" }, "query_params": { "type": "object", "description": "Query Params", "$ref": "#/components/schemas/QueryParams" }, "sort_params": { "type": "object", "properties": { "": { "type": "string", "enum": [ "asc", "desc" ] } } }, "id": { "type": "string", "description": "Id" } } }, "IdpV3N3": { "properties": { "match_email_domain": { "type": "boolean", "description": "Match Email Domain" }, "is_hob": { "type": "boolean", "description": "Is Hob" }, "sign_redirect_binding": { "type": "boolean", "description": "Sign Redirect Binding" }, "auto_provision_roles": { "type": "boolean", "description": "Auto Provision Roles" }, "auto_provision_operators": { "type": "boolean", "description": "Auto Provision Operators" }, "session_timeout_s": { "type": "integer", "description": "Session Timeout S: Range(max = 2147483646L, error = SSO_INVALID_SESSION_TIMEOUT_SEC: Invalid range {validatedValue}. Please use a range between 180 to 2147483646 inclusive, min = 180L) ", "format": "int32" }, "role_map": { "type": "object" }, "sp_metadata_b64": { "type": "string", "description": "Sp Metadata B64: Length(max = 1000000, error = SSO_INVALID_SP_METADATA_B64: Invalid size for service provide metadata, min = 1) " }, "sp_x509_b64": { "type": "string", "description": "Sp X509 B64: Length(max = 100000, error = SSO_INVALID_SP_X509_B64: Invalid size for service provide x509 cert, min = 1) " }, "sp_x509_serial_no": { "type": "string", "description": "Sp X509 Serial No: Length(max = 1024, error = SSO_INVALID_SP_X509_SERIAL_NO: Invalid size for service provide x509 serial no, min = 1) " }, "idp_metadata_b64": { "type": "string", "description": "Idp Metadata B64: Length(max = 1000000, error = SSO_INVALID_IDP_METADATA_B64: Invalid size for IdP metadata, min = 1) " }, "idp_logout_url": { "type": "string", "description": "Idp Logout Url: Length(max = 2048, error = SSO_INVALID_IDP_LOGOUT_URL: Invalid size for logout url, min = 1) " }, "idp_login_url": { "type": "string", "description": "Idp Login Url: Length(max = 2048, error = SSO_INVALID_IDP_SSO_URL: Invalid size for IdP single sign on Url, min = 1) " }, "idp_entity_id": { "type": "string", "description": "Idp Entity Id: Length(max = 2048, error = SSO_INVALID_IDP_ENTITY_ID: Invalid size for entity id in metadata, min = 1) NotEmpty(error = SSO_EMPTY_IDP_ENTITY_ID: Provide entity id for IdP) " }, "idp_domain_admin_email": { "type": "string", "description": "Idp Domain Admin Email: Length(max = 1024, error = SSO_INVALID_IDP_DOMAIN_ADMIN_EMAIL: Provide a valid admin email for IdP domain, min = 1) NotEmpty(error = SSO_EMPTY_IDP_DOMAIN_ADMIN_EMAIL: Provide an admin email for IdP) " }, "idp_domains": { "type": "array", "description": "Idp Domains: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 128, listMaxSize = 100, error = SSO_INVALID_IDP_EMAIL_DOMAIN: Provide valid and unique IdP domain(s), all in lowercase and consist of letters and numbers only, noTrim = false, regex = [0-9a-z._-]+, required = false) ", "items": { "type": "string", "description": "Idp Domains" } }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "boolean", "description": "Disabled" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "boolean", "description": "Inactive" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "idp_entity_id", "idp_domain_admin_email" ] }, "Token": { "properties": { "token": { "type": "string", "description": "Token: Pattern(message = A valid token is required, value = ^[a-zA-Z0-9_-]{1,1000}$) " }, "repeatPassword": { "type": "string", "description": "RepeatPassword: MinLength(message = minLength, value = 1L) MaxLength(message = maxLength, value = 1000L) Required(message = required) " }, "password": { "type": "string", "description": "Password: MinLength(message = minLength, value = 1L) MaxLength(message = maxLength, value = 1000L) Required(message = required) " }, "oldPassword": { "type": "string", "description": "OldPassword: MinLength(message = minLength, value = 1L) MaxLength(message = maxLength, value = 1000L) " } }, "required": [ "repeatPassword", "password" ] }, "IdpV3N1": { "properties": { "sign_redirect_binding": { "type": "boolean", "description": "Sign Redirect Binding" }, "auto_provision_roles": { "type": "boolean", "description": "Auto Provision Roles" }, "auto_provision_operators": { "type": "boolean", "description": "Auto Provision Operators" }, "session_timeout_s": { "type": "integer", "description": "Session Timeout S: Range(max = 2147483646L, error = SSO_INVALID_SESSION_TIMEOUT_SEC: Invalid range {validatedValue}. Please use a range between 180 to 2147483646 inclusive, min = 180L) ", "format": "int32" }, "role_map": { "type": "object" }, "sp_metadata_b64": { "type": "string", "description": "Sp Metadata B64: Length(max = 1000000, error = SSO_INVALID_SP_METADATA_B64: Invalid size for service provide metadata, min = 1) " }, "sp_x509_b64": { "type": "string", "description": "Sp X509 B64: Length(max = 100000, error = SSO_INVALID_SP_X509_B64: Invalid size for service provide x509 cert, min = 1) " }, "sp_x509_serial_no": { "type": "string", "description": "Sp X509 Serial No: Length(max = 1024, error = SSO_INVALID_SP_X509_SERIAL_NO: Invalid size for service provide x509 serial no, min = 1) " }, "idp_metadata_b64": { "type": "string", "description": "Idp Metadata B64: Length(max = 1000000, error = SSO_INVALID_IDP_METADATA_B64: Invalid size for IdP metadata, min = 1) " }, "idp_logout_url": { "type": "string", "description": "Idp Logout Url: Length(max = 2048, error = SSO_INVALID_IDP_LOGOUT_URL: Invalid size for logout url, min = 1) " }, "idp_login_url": { "type": "string", "description": "Idp Login Url: Length(max = 2048, error = SSO_INVALID_IDP_SSO_URL: Invalid size for IdP single sign on Url, min = 1) " }, "idp_entity_id": { "type": "string", "description": "Idp Entity Id: Length(max = 2048, error = SSO_INVALID_IDP_ENTITY_ID: Invalid size for entity id in metadata, min = 1) NotEmpty(error = SSO_EMPTY_IDP_ENTITY_ID: Provide entity id for IdP) " }, "idp_domain_admin_email": { "type": "string", "description": "Idp Domain Admin Email: Length(max = 1024, error = SSO_INVALID_IDP_DOMAIN_ADMIN_EMAIL: Provide a valid admin email for IdP domain, min = 1) NotEmpty(error = SSO_EMPTY_IDP_DOMAIN_ADMIN_EMAIL: Provide an admin email for IdP) " }, "idp_domains": { "type": "array", "description": "Idp Domains: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 128, listMaxSize = 100, error = SSO_INVALID_IDP_EMAIL_DOMAIN: Provide valid and unique IdP domain(s), all in lowercase and consist of letters and numbers only, noTrim = false, regex = [0-9a-z._-]+, required = false) ", "items": { "type": "string", "description": "Idp Domains" } }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "boolean", "description": "Disabled" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "boolean", "description": "Inactive" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "idp_entity_id", "idp_domain_admin_email" ] }, "Operator": { "properties": { "migration_state": { "description": "Migration State", "$ref": "#/components/schemas/MigrationState" }, "is_system_owned": { "type": "boolean", "description": "Is System Owned" }, "enable_session_ip_lock": { "type": "boolean", "description": "Enable Session Ip Lock" }, "esp_tenant_id": { "type": "string", "description": "Esp Tenant Id" }, "from_esp_tenant_id": { "type": "string", "description": "From Esp Tenant Id: Pattern(error = TENANT_INVALID_ID: Provide a valid tenant id, regexp = ^[a-z0-9]{1,50}$) " }, "from_esp_name": { "type": "string", "description": "From Esp Name: Length(max = 512, error = TENANT_INVALID_NAME: Please provide a valid name with a length less than 512 characters, min = 0) " }, "from_esp": { "type": "boolean", "description": "From Esp" }, "is_locked": { "type": "boolean", "description": "Is Locked" }, "settings": { "type": "string", "description": "Settings: Size(max = 100000, error = OPERATOR_INVALID_SETTINGS_SIZE: Invalid data size for settings. Maximum of 100KB data size is allowed, min = 0) " }, "ipv4_list": { "type": "array", "description": "Ipv4 List: Size(max = 100, error = OPERATOR_IPV4_INVALID: Invalid ipv4 list, min = 0) Valid ", "items": { "$ref": "#/components/schemas/IPv4Address" } }, "phone_numbers": { "type": "array", "description": "Phone Numbers: Size(max = 20, error = OPERATOR_INVALID_PHONE_LIST_SIZE: Invalid phone list size. Maximum of twenty phones can be specified, min = 0) Valid ", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "addresses": { "type": "array", "description": "Addresses: Size(max = 20, error = OPERATOR_INVALID_ADDRESS_LIST_SIZE: Provide a valid address list. A maximum of twenty addresses can be specified, min = 0) Valid ", "items": { "$ref": "#/components/schemas/Address" } }, "linked_accounts": { "type": "array", "description": "Linked Accounts: Size(max = 20, error = OPERATOR_INVALID_LINKED_ACCOUNTS_SIZE: Invalid linked account information. Maximum of 20 and at least 1 linked account(s) should be specified, min = 1) NotEmpty ", "items": { "$ref": "#/components/schemas/LinkedAccount" } }, "custom_roles": { "type": "array", "description": "Custom Roles: Size(max = 100, error = OPERATOR_INVALID_CUSTOM_ROLES_LIST_SIZE: Custom roles set is limited to {} length, min = 0) ", "items": { "$ref": "#/components/schemas/CustomRole" } }, "roles": { "type": "array", "description": "Roles: Valid Size(max = 7, error = OPERATOR_INVALID_ROLE_LIST_SIZE: Role list size is invalid. Maximum of seven and at least one role must be specified, min = 0) ", "items": { "$ref": "#/components/schemas/AuthRole" } }, "disable_idp_login": { "type": "boolean", "description": "Disable Idp Login" }, "email_validated": { "type": "boolean", "description": "Email Validated" }, "last_login": { "type": "string", "format": "date" }, "last_name": { "type": "string", "description": "Last Name: Size(max = 100, error = OPERATOR_LNAME_INVALID: Invalid last name {validatedValue}. Please use a last name which is 100 characters or less in length, min = 0) " }, "first_name": { "type": "string", "description": "First Name: Size(max = 100, error = OPERATOR_FNAME_INVALID: Invalid first name {validatedValue}. Please use a first name which is 100 characters or less in length, min = 0) NotEmpty " }, "name": { "type": "string", "description": "Name: JsonIgnore(value = true) " }, "secondary_emails": { "type": "array", "description": "Secondary Emails: Size(max = 20, error = OPERATOR_EMAIL_LIST_INVALID: Invalid email list size {validatedValue}. Please use a valid email list, min = 0) Valid ", "items": { "$ref": "#/components/schemas/Email" } }, "email_iam": { "type": "string", "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) " }, "email": { "type": "string", "description": "Email: Email(error = OPERATOR_EMAIL_INVALID: Invalid email {validatedValue}. Please use a valid email address, regexp = .*) Size(max = 1000, error = OPERATOR_EMAIL_INVALID: Invalid email {validatedValue}. Please use a valid email address, min = 1) NotEmpty " }, "region": { "type": "string", "description": "Region" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "boolean", "description": "Disabled" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "boolean", "description": "Inactive" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string" } }, "required": [ "linked_accounts", "first_name", "email" ] }, "IdpV3N2": { "properties": { "is_hob": { "type": "boolean", "description": "Is Hob" }, "sign_redirect_binding": { "type": "boolean", "description": "Sign Redirect Binding" }, "auto_provision_roles": { "type": "boolean", "description": "Auto Provision Roles" }, "auto_provision_operators": { "type": "boolean", "description": "Auto Provision Operators" }, "session_timeout_s": { "type": "integer", "description": "Session Timeout S: Range(max = 2147483646L, error = SSO_INVALID_SESSION_TIMEOUT_SEC: Invalid range {validatedValue}. Please use a range between 180 to 2147483646 inclusive, min = 180L) ", "format": "int32" }, "role_map": { "type": "object" }, "sp_metadata_b64": { "type": "string", "description": "Sp Metadata B64: Length(max = 1000000, error = SSO_INVALID_SP_METADATA_B64: Invalid size for service provide metadata, min = 1) " }, "sp_x509_b64": { "type": "string", "description": "Sp X509 B64: Length(max = 100000, error = SSO_INVALID_SP_X509_B64: Invalid size for service provide x509 cert, min = 1) " }, "sp_x509_serial_no": { "type": "string", "description": "Sp X509 Serial No: Length(max = 1024, error = SSO_INVALID_SP_X509_SERIAL_NO: Invalid size for service provide x509 serial no, min = 1) " }, "idp_metadata_b64": { "type": "string", "description": "Idp Metadata B64: Length(max = 1000000, error = SSO_INVALID_IDP_METADATA_B64: Invalid size for IdP metadata, min = 1) " }, "idp_logout_url": { "type": "string", "description": "Idp Logout Url: Length(max = 2048, error = SSO_INVALID_IDP_LOGOUT_URL: Invalid size for logout url, min = 1) " }, "idp_login_url": { "type": "string", "description": "Idp Login Url: Length(max = 2048, error = SSO_INVALID_IDP_SSO_URL: Invalid size for IdP single sign on Url, min = 1) " }, "idp_entity_id": { "type": "string", "description": "Idp Entity Id: Length(max = 2048, error = SSO_INVALID_IDP_ENTITY_ID: Invalid size for entity id in metadata, min = 1) NotEmpty(error = SSO_EMPTY_IDP_ENTITY_ID: Provide entity id for IdP) " }, "idp_domain_admin_email": { "type": "string", "description": "Idp Domain Admin Email: Length(max = 1024, error = SSO_INVALID_IDP_DOMAIN_ADMIN_EMAIL: Provide a valid admin email for IdP domain, min = 1) NotEmpty(error = SSO_EMPTY_IDP_DOMAIN_ADMIN_EMAIL: Provide an admin email for IdP) " }, "idp_domains": { "type": "array", "description": "Idp Domains: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 128, listMaxSize = 100, error = SSO_INVALID_IDP_EMAIL_DOMAIN: Provide valid and unique IdP domain(s), all in lowercase and consist of letters and numbers only, noTrim = false, regex = [0-9a-z._-]+, required = false) ", "items": { "type": "string", "description": "Idp Domains" } }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "boolean", "description": "Disabled" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "boolean", "description": "Inactive" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "idp_entity_id", "idp_domain_admin_email" ] }, "AuthTokenV2N1": { "properties": { "is_system_owned": { "type": "boolean", "description": "Is System Owned" }, "expires_utc_ms": { "type": "integer", "description": "Expires Utc Ms", "format": "int64" }, "x_auth_token": { "type": "string", "description": "X Auth Token" }, "session_key_c": { "type": "string", "description": "Session Key C: Length(max = 128, , min = 0) " }, "custom_roles": { "type": "array", "description": "Custom Roles: Size(max = 100, error = SESSION_INVALID_CUSTOM_ROLES_LIST_SIZE: Custom permissions set is limited to {} length, min = 0) ", "items": { "$ref": "#/components/schemas/CustomRole" } }, "roles": { "type": "array", "description": "Roles: Valid Size(max = 7, error = SESSION_INVALID_ROLE_LIST_SIZE: Roles set size is limited to {} length, min = 0) ", "items": { "$ref": "#/components/schemas/AuthRole" } }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "OperatorV2N2": { "properties": { "migration_state": { "description": "Migration State", "$ref": "#/components/schemas/MigrationState" }, "email_iam": { "type": "string", "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) " }, "region": { "type": "string", "description": "Region" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "boolean", "description": "Disabled" }, "inactive": { "type": "boolean", "description": "Inactive" }, "is_system_owned": { "type": "boolean", "description": "Is System Owned" }, "enable_session_ip_lock": { "type": "boolean", "description": "Enable Session Ip Lock" }, "from_esp_tenant_id": { "type": "string", "description": "From Esp Tenant Id: Pattern(error = TENANT_INVALID_ID: Provide a valid tenant id, regexp = ^[a-z0-9]{1,50}$) " }, "from_esp_name": { "type": "string", "description": "From Esp Name: Length(max = 512, error = TENANT_INVALID_NAME: Please provide a valid name with a length less than 512 characters, min = 0) " }, "from_esp": { "type": "boolean", "description": "From Esp" }, "is_locked": { "type": "boolean", "description": "Is Locked" }, "settings": { "type": "string", "description": "Settings: Size(max = 100000, error = OPERATOR_INVALID_SETTINGS_SIZE: Invalid data size for settings. Maximum of 100KB data size is allowed, min = 0) " }, "ipv4_list": { "type": "array", "description": "Ipv4 List: Size(max = 100, error = OPERATOR_IPV4_INVALID: Invalid ipv4 list, min = 0) Valid ", "items": { "$ref": "#/components/schemas/IPv4Address" } }, "phone_numbers": { "type": "array", "description": "Phone Numbers: Size(max = 20, error = OPERATOR_INVALID_PHONE_LIST_SIZE: Invalid phone list size. Maximum of twenty phones can be specified, min = 0) Valid ", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "addresses": { "type": "array", "description": "Addresses: Size(max = 20, error = OPERATOR_INVALID_ADDRESS_LIST_SIZE: Provide a valid address list. A maximum of twenty addresses can be specified, min = 0) Valid ", "items": { "$ref": "#/components/schemas/Address" } }, "linked_accounts": { "type": "array", "description": "Linked Accounts: Size(max = 20, error = OPERATOR_INVALID_LINKED_ACCOUNTS_SIZE: Invalid linked account information. Maximum of 20 and at least 1 linked account(s) should be specified, min = 1) NotEmpty ", "items": { "$ref": "#/components/schemas/LinkedAccount" } }, "custom_roles": { "type": "array", "description": "Custom Roles: Size(max = 100, error = OPERATOR_INVALID_CUSTOM_ROLES_LIST_SIZE: Custom roles set is limited to {} length, min = 0) ", "items": { "$ref": "#/components/schemas/CustomRoleV2N1" } }, "roles": { "type": "array", "description": "Roles: Valid Size(max = 7, error = OPERATOR_INVALID_ROLE_LIST_SIZE: Role list size is invalid. Maximum of seven and at least one role must be specified, min = 0) ", "items": { "$ref": "#/components/schemas/AuthRole" } }, "disable_idp_login": { "type": "boolean", "description": "Disable Idp Login" }, "email_validated": { "type": "boolean", "description": "Email Validated" }, "last_login": { "type": "string", "format": "date" }, "last_name": { "type": "string", "description": "Last Name: Size(max = 100, error = OPERATOR_LNAME_INVALID: Invalid last name {validatedValue}. Please use a last name which is 100 characters or less in length, min = 0) " }, "first_name": { "type": "string", "description": "First Name: Size(max = 100, error = OPERATOR_FNAME_INVALID: Invalid first name {validatedValue}. Please use a first name which is 100 characters or less in length, min = 0) NotEmpty " }, "secondary_emails": { "type": "array", "description": "Secondary Emails: Size(max = 20, error = OPERATOR_EMAIL_LIST_INVALID: Invalid email list size {validatedValue}. Please use a valid email list, min = 0) Valid ", "items": { "$ref": "#/components/schemas/Email" } }, "email": { "type": "string", "description": "Email: Email(error = OPERATOR_EMAIL_INVALID: Invalid email {validatedValue}. Please use a valid email address, regexp = .*) Size(max = 1000, error = OPERATOR_EMAIL_INVALID: Invalid email {validatedValue}. Please use a valid email address, min = 1) NotEmpty " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "linked_accounts", "first_name", "email" ] }, "CertificateCa": { "properties": { "parent_id": { "description": "Parent Id", "$ref": "#/components/schemas/CertificateCa" }, "certificate_expiry_utc": { "type": "integer", "description": "Certificate Expiry Utc", "format": "int64" }, "certificate": { "type": "string", "description": "Certificate" }, "certificate_type": { "type": "string", "description": "Certificate Type" }, "serial_number": { "type": "string", "description": "Serial Number" }, "version": { "type": "string", "description": "Version" }, "issued_by": { "description": "Issued By", "$ref": "#/components/schemas/CertificateIssuer" }, "issued_to": { "description": "Issued To", "$ref": "#/components/schemas/CertificateIssuer" }, "region": { "type": "string", "description": "Region" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "boolean", "description": "Disabled" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "boolean", "description": "Inactive" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string" } } }, "OperatorV2N1": { "properties": { "region": { "type": "string", "description": "Region" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "boolean", "description": "Disabled" }, "inactive": { "type": "boolean", "description": "Inactive" }, "is_system_owned": { "type": "boolean", "description": "Is System Owned" }, "enable_session_ip_lock": { "type": "boolean", "description": "Enable Session Ip Lock" }, "from_esp_tenant_id": { "type": "string", "description": "From Esp Tenant Id: Pattern(error = TENANT_INVALID_ID: Provide a valid tenant id, regexp = ^[a-z0-9]{1,50}$) " }, "from_esp_name": { "type": "string", "description": "From Esp Name: Length(max = 512, error = TENANT_INVALID_NAME: Please provide a valid name with a length less than 512 characters, min = 0) " }, "from_esp": { "type": "boolean", "description": "From Esp" }, "is_locked": { "type": "boolean", "description": "Is Locked" }, "settings": { "type": "string", "description": "Settings: Size(max = 100000, error = OPERATOR_INVALID_SETTINGS_SIZE: Invalid data size for settings. Maximum of 100KB data size is allowed, min = 0) " }, "ipv4_list": { "type": "array", "description": "Ipv4 List: Size(max = 100, error = OPERATOR_IPV4_INVALID: Invalid ipv4 list, min = 0) Valid ", "items": { "$ref": "#/components/schemas/IPv4Address" } }, "phone_numbers": { "type": "array", "description": "Phone Numbers: Size(max = 20, error = OPERATOR_INVALID_PHONE_LIST_SIZE: Invalid phone list size. Maximum of twenty phones can be specified, min = 0) Valid ", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "addresses": { "type": "array", "description": "Addresses: Size(max = 20, error = OPERATOR_INVALID_ADDRESS_LIST_SIZE: Provide a valid address list. A maximum of twenty addresses can be specified, min = 0) Valid ", "items": { "$ref": "#/components/schemas/Address" } }, "linked_accounts": { "type": "array", "description": "Linked Accounts: Size(max = 20, error = OPERATOR_INVALID_LINKED_ACCOUNTS_SIZE: Invalid linked account information. Maximum of 20 and at least 1 linked account(s) should be specified, min = 1) NotEmpty ", "items": { "$ref": "#/components/schemas/LinkedAccount" } }, "custom_roles": { "type": "array", "description": "Custom Roles: Size(max = 100, error = OPERATOR_INVALID_CUSTOM_ROLES_LIST_SIZE: Custom roles set is limited to {} length, min = 0) ", "items": { "$ref": "#/components/schemas/CustomRoleV2N1" } }, "roles": { "type": "array", "description": "Roles: Valid Size(max = 7, error = OPERATOR_INVALID_ROLE_LIST_SIZE: Role list size is invalid. Maximum of seven and at least one role must be specified, min = 0) ", "items": { "$ref": "#/components/schemas/AuthRole" } }, "disable_idp_login": { "type": "boolean", "description": "Disable Idp Login" }, "email_validated": { "type": "boolean", "description": "Email Validated" }, "last_login": { "type": "string", "format": "date" }, "last_name": { "type": "string", "description": "Last Name: Size(max = 100, error = OPERATOR_LNAME_INVALID: Invalid last name {validatedValue}. Please use a last name which is 100 characters or less in length, min = 0) " }, "first_name": { "type": "string", "description": "First Name: Size(max = 100, error = OPERATOR_FNAME_INVALID: Invalid first name {validatedValue}. Please use a first name which is 100 characters or less in length, min = 0) NotEmpty " }, "name": { "type": "string", "description": "Name: JsonIgnore(value = true) " }, "secondary_emails": { "type": "array", "description": "Secondary Emails: Size(max = 20, error = OPERATOR_EMAIL_LIST_INVALID: Invalid email list size {validatedValue}. Please use a valid email list, min = 0) Valid ", "items": { "$ref": "#/components/schemas/Email" } }, "email": { "type": "string", "description": "Email: Email(error = OPERATOR_EMAIL_INVALID: Invalid email {validatedValue}. Please use a valid email address, regexp = .*) Size(max = 1000, error = OPERATOR_EMAIL_INVALID: Invalid email {validatedValue}. Please use a valid email address, min = 1) NotEmpty " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "linked_accounts", "first_name", "email" ] }, "Identity": { "properties": { "email": { "type": "string", "description": "Email: Email(message = email) MaxLength(message = maxLength, value = 1000L) " } } }, "SamlRequest": { "properties": { "LoginHint": { "type": "string", "description": "LoginHint" }, "requestId": { "type": "string", "description": "RequestId" }, "login_region": { "type": "string", "description": "Login Region" }, "api_endpoint": { "type": "string", "description": "Api Endpoint" }, "urlpath": { "type": "string", "description": "Urlpath" }, "username": { "type": "string", "description": "Username" }, "RelayState": { "type": "string", "description": "RelayState" }, "SAMLRequest": { "type": "string", "description": "SAMLRequest" }, "url": { "type": "string", "description": "Url" }, "method": { "type": "string", "description": "Method" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "LinkedAccount": { "properties": { "inactive_reason": { "type": "string", "description": "Inactive Reason" }, "region": { "type": "string", "description": "Region" }, "disabled_reason": { "type": "string", "description": "Disabled Reason" }, "inactive": { "type": "boolean", "description": "Inactive" }, "disabled": { "type": "boolean", "description": "Disabled" }, "failed_login_attempts": { "type": "integer", "description": "Failed Login Attempts", "format": "int32" }, "provider_value_updated_on": { "type": "integer", "description": "Provider Value Updated On", "format": "int64" }, "provider_key": { "type": "string", "description": "Provider Key: Pattern(error = LINKED_ACCOUNT_PROVIDER_KEY: Linked account provider key is invalid, regexp = (password)) " }, "provider_value": { "type": "string", "description": "Provider Value" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "TenantV2N7": { "properties": { "": { "type": "string", "description": "X Panw Region" }, "is_oneapp_ready": { "type": "boolean", "description": "Is Oneapp Ready" }, "is_pa_iot_security_license": { "type": "boolean", "description": "Is Pa Iot Security License" }, "tsg_instances": { "type": "array", "description": "Tsg Instances: Valid ", "items": { "$ref": "#/components/schemas/TsgInstance" } }, "sase_at": { "type": "string", "format": "date" }, "tsg_id": { "type": "string", "description": "Tsg Id: Length(max = 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support, min = 0) Digits(fraction = 0, integer = 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support) " }, "csp_tenant_id": { "type": "string", "description": "Csp Tenant Id: Length(max = 32, TENANT_INVALID_CSP_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_CSP_IT_TENANT_ID) " }, "telemetry_region": { "type": "string", "description": "Telemetry Region" }, "prisma_access_tenant_id": { "type": "string", "description": "Prisma Access Tenant Id: Length(max = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID) " }, "pan_tenant_id": { "type": "string", "description": "Pan Tenant Id: Length(max = 32, TENANT_INVALID_PAN_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PAN_IT_TENANT_ID) " }, "pan_account_id": { "type": "string", "description": "Pan Account Id: Length(max = 32, TENANT_INVALID_PAN_CSP_ACCOUNT_ID, min = 0) " }, "region": { "type": "string", "description": "Region" }, "clients": { "type": "array", "description": "Clients: Valid ", "items": { "type": "string", "description": "Clients" } }, "is_support": { "type": "boolean", "description": "Is Support" }, "is_esp": { "type": "boolean", "description": "Is Esp" }, "provider_data": { "type": "array", "description": "Provider Data: Valid ", "items": { "$ref": "#/components/schemas/ProviderData" } }, "operator": { "description": "Operator", "$ref": "#/components/schemas/Operator" }, "password_policy": { "description": "Password Policy: Valid ", "$ref": "#/components/schemas/PasswordPolicy" }, "ipv4_list": { "type": "array", "description": "Ipv4 List: Valid ", "items": { "$ref": "#/components/schemas/IPv4Address" } }, "phone_numbers": { "type": "array", "description": "Phone Numbers: Valid ", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "address": { "description": "Address: Valid ", "$ref": "#/components/schemas/Address" }, "description": { "type": "string", "description": "Description: Length(max = 1024, error = TENANT_INVALID_DESCRIPTION: Please provide a description with a length less than 1024 characters, min = 0) " }, "name": { "type": "string", "description": "Name: Length(max = 512, error = TENANT_INVALID_NAME: Please provide a valid name with a length less than 512 characters, min = 0) " }, "canonical_name": { "type": "string", "description": "Canonical Name: Pattern(error = TENANT_INVALID_CANONICAL_NAME: Please provide a valid canonical name with a length less than 128 characters, e.g., mydomain.com, regexp = [0-9a-zA-Z\\\\.\\\\-_]{1,128}) " }, "id": { "type": "string", "description": "Id" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "string", "description": "Inactive" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "string", "description": "Disabled" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" } } }, "TenantV2N9": { "properties": { "app_acceleration_enabled": { "type": "boolean", "description": "App Acceleration Enabled" }, "adem_enabled": { "type": "boolean", "description": "Adem Enabled" }, "": { "type": "string", "description": "X Panw Region" }, "is_oneapp_ready": { "type": "boolean", "description": "Is Oneapp Ready" }, "is_pa_iot_security_license": { "type": "boolean", "description": "Is Pa Iot Security License" }, "tsg_instances": { "type": "array", "description": "Tsg Instances: Valid ", "items": { "$ref": "#/components/schemas/TsgInstance" } }, "sase_at": { "type": "string", "format": "date" }, "tsg_id": { "type": "string", "description": "Tsg Id: Length(max = 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support, min = 0) Digits(fraction = 0, integer = 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support) " }, "csp_tenant_id": { "type": "string", "description": "Csp Tenant Id: Length(max = 32, TENANT_INVALID_CSP_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_CSP_IT_TENANT_ID) " }, "telemetry_region": { "type": "string", "description": "Telemetry Region" }, "prisma_access_tenant_id": { "type": "string", "description": "Prisma Access Tenant Id: Length(max = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID) " }, "pan_tenant_id": { "type": "string", "description": "Pan Tenant Id: Length(max = 32, TENANT_INVALID_PAN_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PAN_IT_TENANT_ID) " }, "pan_account_id": { "type": "string", "description": "Pan Account Id: Length(max = 32, TENANT_INVALID_PAN_CSP_ACCOUNT_ID, min = 0) " }, "region": { "type": "string", "description": "Region" }, "clients": { "type": "array", "description": "Clients: Valid ", "items": { "type": "string", "description": "Clients" } }, "is_support": { "type": "boolean", "description": "Is Support" }, "is_esp": { "type": "boolean", "description": "Is Esp" }, "provider_data": { "type": "array", "description": "Provider Data: Valid ", "items": { "$ref": "#/components/schemas/ProviderData" } }, "operator": { "description": "Operator", "$ref": "#/components/schemas/Operator" }, "password_policy": { "description": "Password Policy: Valid ", "$ref": "#/components/schemas/PasswordPolicy" }, "ipv4_list": { "type": "array", "description": "Ipv4 List: Valid ", "items": { "$ref": "#/components/schemas/IPv4Address" } }, "phone_numbers": { "type": "array", "description": "Phone Numbers: Valid ", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "address": { "description": "Address: Valid ", "$ref": "#/components/schemas/Address" }, "description": { "type": "string", "description": "Description: Length(max = 1024, error = TENANT_INVALID_DESCRIPTION: Please provide a description with a length less than 1024 characters, min = 0) " }, "name": { "type": "string", "description": "Name: Length(max = 512, error = TENANT_INVALID_NAME: Please provide a valid name with a length less than 512 characters, min = 0) " }, "canonical_name": { "type": "string", "description": "Canonical Name: Pattern(error = TENANT_INVALID_CANONICAL_NAME: Please provide a valid canonical name with a length less than 128 characters, e.g., mydomain.com, regexp = [0-9a-zA-Z\\\\.\\\\-_]{1,128}) " }, "id": { "type": "string", "description": "Id" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "string", "description": "Inactive" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "string", "description": "Disabled" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" } } }, "Signup": { "properties": { "enable_session_ip_lock": { "type": "boolean", "description": "Enable Session Ip Lock" }, "ipv4_list": { "type": "array", "description": "Ipv4 List", "items": { "$ref": "#/components/schemas/IPv4Address" } }, "secondary_emails": { "type": "array", "description": "Secondary Emails", "items": { "$ref": "#/components/schemas/Email" } }, "custom_roles": { "type": "array", "description": "Custom Roles", "items": { "$ref": "#/components/schemas/CustomRole" } }, "roles": { "type": "array", "description": "Roles", "items": { "$ref": "#/components/schemas/AuthRole" } }, "phone_numbers": { "type": "array", "description": "Phone Numbers", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "addresses": { "type": "array", "description": "Addresses", "items": { "$ref": "#/components/schemas/Address" } }, "last_name": { "type": "string", "description": "Last Name: Pattern(message = A valid last name is required, value = ^[a-zA-Z0-9\\\\s_-]{0,100}$) " }, "first_name": { "type": "string", "description": "First Name: Pattern(message = A valid first name is required, value = ^[a-zA-Z0-9\\\\s_-]{1,100}$) " }, "name": { "type": "string", "description": "Name: Pattern(message = A valid name is required, value = ^[ a-zA-Z0-9_-]{0,210}$) " }, "repeatPassword": { "type": "string", "description": "RepeatPassword: Required(message = required) MinLength(message = minLength, value = 1L) MaxLength(message = maxLength, value = 1000L) " }, "logout_others": { "type": "boolean", "description": "Logout Others" }, "requestId": { "type": "string", "description": "RequestId: MinLength(message = minLength, value = 1L) MaxLength(message = maxLength, value = 200L) " }, "password": { "type": "string", "description": "Password: MinLength(message = minLength, value = 1L) MaxLength(message = maxLength, value = 1000L) " }, "email": { "type": "string", "description": "Email: Email(message = email) MaxLength(message = maxLength, value = 1000L) " } }, "required": [ "repeatPassword" ] }, "QueryParams": { "properties": { "|comparator": { "type": "object", "additionalProperties": { "type": "object", "properties": { "gte": { "type": "string" }, "lte": { "type": "string" }, "eq": { "type": "string" }, "neq": { "type": "string" }, "in": { "type": "array", "items": { "type": "string" } } } } } } }, "Extension": { "properties": { "conf": { "type": "object" }, "disabled": { "type": "boolean", "description": "Disabled" }, "namespace": { "type": "string", "description": "Namespace: NotEmpty(error = EXTENSION_NAMESPACE_REQD: Provide valid {} attribute) Pattern(error = INVALID_EXTENSION_NAMESPACE: Provide valid {} attribute. Invalid value {}, regexp = ^[a-z][a-z0-9/]*[a-z0-9]+$) " }, "name": { "type": "string", "description": "Name: NotEmpty(error = EXTENSION_NAME_REQD: Provide valid {} attribute) Size(max = 128, error = INVALID_EXTENSION_NAME: Provide valid {} attribute. Invalid value {}, min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" }, "entity_id": { "type": "string", "description": "Entity Id: Pattern(error = INVALID_ENTITY_ID: Invalid entity id. Only numbers are allowed., regexp = [0-9]+$) " } }, "required": [ "conf", "namespace", "name" ] }, "ListQueryResponse": { "type": "object", "properties": { "deleted_ids": { "type": "array", "items": { "type": "string" } }, "deleted_count": { "type": "integer", "format": "int64" }, "total_count": { "type": "integer", "format": "int64" }, "next_query": { "type": "object" }, "count": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "PasswordReset": { "properties": { "token": { "type": "string", "description": "Token: Pattern(message = A valid token is required, value = ^[a-zA-Z0-9_-]{1,1000}$) " }, "repeatPassword": { "type": "string", "description": "RepeatPassword: MinLength(message = minLength, value = 1L) MaxLength(message = maxLength, value = 1000L) Required(message = required) " }, "password": { "type": "string", "description": "Password: MinLength(message = minLength, value = 1L) MaxLength(message = maxLength, value = 1000L) Required(message = required) " }, "oldPassword": { "type": "string", "description": "OldPassword: MinLength(message = minLength, value = 1L) MaxLength(message = maxLength, value = 1000L) " } }, "required": [ "repeatPassword", "password" ] }, "Tenant": { "properties": { "region": { "type": "string", "description": "Region" }, "clients": { "type": "array", "description": "Clients: Valid ", "items": { "type": "string", "description": "Clients" } }, "is_support": { "type": "boolean", "description": "Is Support" }, "is_esp": { "type": "boolean", "description": "Is Esp" }, "provider_data": { "type": "array", "description": "Provider Data: Valid ", "items": { "$ref": "#/components/schemas/ProviderData" } }, "operator": { "description": "Operator", "$ref": "#/components/schemas/Operator" }, "password_policy": { "description": "Password Policy: Valid ", "$ref": "#/components/schemas/PasswordPolicy" }, "ipv4_list": { "type": "array", "description": "Ipv4 List: Valid ", "items": { "$ref": "#/components/schemas/IPv4Address" } }, "phone_numbers": { "type": "array", "description": "Phone Numbers: Valid ", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "address": { "description": "Address: Valid ", "$ref": "#/components/schemas/Address" }, "description": { "type": "string", "description": "Description: Length(max = 1024, error = TENANT_INVALID_DESCRIPTION: Please provide a description with a length less than 1024 characters, min = 0) " }, "name": { "type": "string", "description": "Name: Length(max = 512, error = TENANT_INVALID_NAME: Please provide a valid name with a length less than 512 characters, min = 0) " }, "canonical_name": { "type": "string", "description": "Canonical Name: Pattern(error = TENANT_INVALID_CANONICAL_NAME: Please provide a valid canonical name with a length less than 128 characters, e.g., mydomain.com, regexp = [0-9a-zA-Z\\\\.\\\\-_]{1,128}) " }, "id": { "type": "string", "description": "Id" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "string", "description": "Inactive" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "string", "description": "Disabled" }, "tenant_id": { "type": "string", "description": "Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" } }, "required": [ "tenant_id" ] }, "AuthRole": { "properties": { "name": { "type": "string", "description": "Name: Pattern(AUTH_ROLE_INVALID, regexp = (guest|system|element|support_iam_admin|support_admin|support_viewonly|support_mfg|support_super|support_root|devops|secops|tenant_iam_admin|tenant_network_admin|tenant_security_admin|tenant_viewonly|tenant_super|tenant_root|esp_iam_admin|esp_machine_admin|esp_admin|esp_user|esp_super|esp_root)) NotBlank " } }, "required": [ "name" ] }, "AuthResource": { "properties": { "disallowed_permissions": { "type": "object" }, "permissions": { "type": "object" }, "custom_roles": { "type": "array", "description": "Custom Roles", "items": { "$ref": "#/components/schemas/CustomRole" } }, "version_exceptions_map": { "type": "array", "description": "Version Exceptions Map", "items": { "type": "object" } }, "resource_role_map": { "type": "array", "description": "Resource Role Map", "items": { "type": "object" } }, "resource_uri_map": { "type": "object" }, "resource_version_map": { "type": "object" }, "redirect_urlpath": { "type": "string", "description": "Redirect Urlpath" }, "redirect_region": { "type": "string", "description": "Redirect Region" }, "redirect_x_auth_token": { "type": "string", "description": "Redirect X Auth Token" }, "x_auth_token": { "type": "string", "description": "X Auth Token" }, "operator_id": { "type": "string", "description": "Operator Id" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "TenantV2N4": { "properties": { "sase_at": { "type": "string", "format": "date" }, "tsg_id": { "type": "string", "description": "Tsg Id: Length(max = 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support, min = 0) Digits(fraction = 0, integer = 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support) " }, "csp_tenant_id": { "type": "string", "description": "Csp Tenant Id: Length(max = 32, TENANT_INVALID_CSP_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_CSP_IT_TENANT_ID) " }, "telemetry_region": { "type": "string", "description": "Telemetry Region" }, "prisma_access_tenant_id": { "type": "string", "description": "Prisma Access Tenant Id: Length(max = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID) " }, "pan_tenant_id": { "type": "string", "description": "Pan Tenant Id: Length(max = 32, TENANT_INVALID_PAN_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PAN_IT_TENANT_ID) " }, "pan_account_id": { "type": "string", "description": "Pan Account Id: Length(max = 32, TENANT_INVALID_PAN_CSP_ACCOUNT_ID, min = 0) " }, "region": { "type": "string", "description": "Region" }, "clients": { "type": "array", "description": "Clients: Valid ", "items": { "type": "string", "description": "Clients" } }, "is_support": { "type": "boolean", "description": "Is Support" }, "is_esp": { "type": "boolean", "description": "Is Esp" }, "provider_data": { "type": "array", "description": "Provider Data: Valid ", "items": { "$ref": "#/components/schemas/ProviderData" } }, "operator": { "description": "Operator", "$ref": "#/components/schemas/Operator" }, "password_policy": { "description": "Password Policy: Valid ", "$ref": "#/components/schemas/PasswordPolicy" }, "ipv4_list": { "type": "array", "description": "Ipv4 List: Valid ", "items": { "$ref": "#/components/schemas/IPv4Address" } }, "phone_numbers": { "type": "array", "description": "Phone Numbers: Valid ", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "address": { "description": "Address: Valid ", "$ref": "#/components/schemas/Address" }, "description": { "type": "string", "description": "Description: Length(max = 1024, error = TENANT_INVALID_DESCRIPTION: Please provide a description with a length less than 1024 characters, min = 0) " }, "name": { "type": "string", "description": "Name: Length(max = 512, error = TENANT_INVALID_NAME: Please provide a valid name with a length less than 512 characters, min = 0) " }, "canonical_name": { "type": "string", "description": "Canonical Name: Pattern(error = TENANT_INVALID_CANONICAL_NAME: Please provide a valid canonical name with a length less than 128 characters, e.g., mydomain.com, regexp = [0-9a-zA-Z\\\\.\\\\-_]{1,128}) " }, "id": { "type": "string", "description": "Id" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "string", "description": "Inactive" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "string", "description": "Disabled" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" } } }, "TenantV2N3": { "properties": { "csp_tenant_id": { "type": "string", "description": "Csp Tenant Id: Length(max = 32, TENANT_INVALID_CSP_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_CSP_IT_TENANT_ID) " }, "telemetry_region": { "type": "string", "description": "Telemetry Region" }, "prisma_access_tenant_id": { "type": "string", "description": "Prisma Access Tenant Id: Length(max = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID) " }, "pan_tenant_id": { "type": "string", "description": "Pan Tenant Id: Length(max = 32, TENANT_INVALID_PAN_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PAN_IT_TENANT_ID) " }, "pan_account_id": { "type": "string", "description": "Pan Account Id: Length(max = 32, TENANT_INVALID_PAN_CSP_ACCOUNT_ID, min = 0) " }, "region": { "type": "string", "description": "Region" }, "clients": { "type": "array", "description": "Clients: Valid ", "items": { "type": "string", "description": "Clients" } }, "is_support": { "type": "boolean", "description": "Is Support" }, "is_esp": { "type": "boolean", "description": "Is Esp" }, "provider_data": { "type": "array", "description": "Provider Data: Valid ", "items": { "$ref": "#/components/schemas/ProviderData" } }, "operator": { "description": "Operator", "$ref": "#/components/schemas/Operator" }, "password_policy": { "description": "Password Policy: Valid ", "$ref": "#/components/schemas/PasswordPolicy" }, "ipv4_list": { "type": "array", "description": "Ipv4 List: Valid ", "items": { "$ref": "#/components/schemas/IPv4Address" } }, "phone_numbers": { "type": "array", "description": "Phone Numbers: Valid ", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "address": { "description": "Address: Valid ", "$ref": "#/components/schemas/Address" }, "description": { "type": "string", "description": "Description: Length(max = 1024, error = TENANT_INVALID_DESCRIPTION: Please provide a description with a length less than 1024 characters, min = 0) " }, "name": { "type": "string", "description": "Name: Length(max = 512, error = TENANT_INVALID_NAME: Please provide a valid name with a length less than 512 characters, min = 0) " }, "canonical_name": { "type": "string", "description": "Canonical Name: Pattern(error = TENANT_INVALID_CANONICAL_NAME: Please provide a valid canonical name with a length less than 128 characters, e.g., mydomain.com, regexp = [0-9a-zA-Z\\\\.\\\\-_]{1,128}) " }, "id": { "type": "string", "description": "Id" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "string", "description": "Inactive" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "string", "description": "Disabled" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" } } }, "Error": { "properties": { "_error": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "TenantV2N5": { "properties": { "is_pa_iot_security_license": { "type": "boolean", "description": "Is Pa Iot Security License" }, "tsg_instances": { "type": "array", "description": "Tsg Instances: Valid ", "items": { "$ref": "#/components/schemas/TsgInstance" } }, "sase_at": { "type": "string", "format": "date" }, "tsg_id": { "type": "string", "description": "Tsg Id: Length(max = 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support, min = 0) Digits(fraction = 0, integer = 32, error = TENANT_INVALID_TSG_ID: Invalid tsg id found. Contact support) " }, "csp_tenant_id": { "type": "string", "description": "Csp Tenant Id: Length(max = 32, TENANT_INVALID_CSP_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_CSP_IT_TENANT_ID) " }, "telemetry_region": { "type": "string", "description": "Telemetry Region" }, "prisma_access_tenant_id": { "type": "string", "description": "Prisma Access Tenant Id: Length(max = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID) " }, "pan_tenant_id": { "type": "string", "description": "Pan Tenant Id: Length(max = 32, TENANT_INVALID_PAN_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PAN_IT_TENANT_ID) " }, "pan_account_id": { "type": "string", "description": "Pan Account Id: Length(max = 32, TENANT_INVALID_PAN_CSP_ACCOUNT_ID, min = 0) " }, "region": { "type": "string", "description": "Region" }, "clients": { "type": "array", "description": "Clients: Valid ", "items": { "type": "string", "description": "Clients" } }, "is_support": { "type": "boolean", "description": "Is Support" }, "is_esp": { "type": "boolean", "description": "Is Esp" }, "provider_data": { "type": "array", "description": "Provider Data: Valid ", "items": { "$ref": "#/components/schemas/ProviderData" } }, "operator": { "description": "Operator", "$ref": "#/components/schemas/Operator" }, "password_policy": { "description": "Password Policy: Valid ", "$ref": "#/components/schemas/PasswordPolicy" }, "ipv4_list": { "type": "array", "description": "Ipv4 List: Valid ", "items": { "$ref": "#/components/schemas/IPv4Address" } }, "phone_numbers": { "type": "array", "description": "Phone Numbers: Valid ", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "address": { "description": "Address: Valid ", "$ref": "#/components/schemas/Address" }, "description": { "type": "string", "description": "Description: Length(max = 1024, error = TENANT_INVALID_DESCRIPTION: Please provide a description with a length less than 1024 characters, min = 0) " }, "name": { "type": "string", "description": "Name: Length(max = 512, error = TENANT_INVALID_NAME: Please provide a valid name with a length less than 512 characters, min = 0) " }, "canonical_name": { "type": "string", "description": "Canonical Name: Pattern(error = TENANT_INVALID_CANONICAL_NAME: Please provide a valid canonical name with a length less than 128 characters, e.g., mydomain.com, regexp = [0-9a-zA-Z\\\\.\\\\-_]{1,128}) " }, "id": { "type": "string", "description": "Id" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "string", "description": "Inactive" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "string", "description": "Disabled" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" } } }, "TenantV2N2": { "properties": { "prisma_access_tenant_id": { "type": "string", "description": "Prisma Access Tenant Id: Length(max = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PRISMA_ACCESS_TENANT_ID) " }, "pan_tenant_id": { "type": "string", "description": "Pan Tenant Id: Length(max = 32, TENANT_INVALID_PAN_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PAN_IT_TENANT_ID) " }, "pan_account_id": { "type": "string", "description": "Pan Account Id: Length(max = 32, TENANT_INVALID_PAN_CSP_ACCOUNT_ID, min = 0) " }, "region": { "type": "string", "description": "Region" }, "clients": { "type": "array", "description": "Clients: Valid ", "items": { "type": "string", "description": "Clients" } }, "is_support": { "type": "boolean", "description": "Is Support" }, "is_esp": { "type": "boolean", "description": "Is Esp" }, "provider_data": { "type": "array", "description": "Provider Data: Valid ", "items": { "$ref": "#/components/schemas/ProviderData" } }, "operator": { "description": "Operator", "$ref": "#/components/schemas/Operator" }, "password_policy": { "description": "Password Policy: Valid ", "$ref": "#/components/schemas/PasswordPolicy" }, "ipv4_list": { "type": "array", "description": "Ipv4 List: Valid ", "items": { "$ref": "#/components/schemas/IPv4Address" } }, "phone_numbers": { "type": "array", "description": "Phone Numbers: Valid ", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "address": { "description": "Address: Valid ", "$ref": "#/components/schemas/Address" }, "description": { "type": "string", "description": "Description: Length(max = 1024, error = TENANT_INVALID_DESCRIPTION: Please provide a description with a length less than 1024 characters, min = 0) " }, "name": { "type": "string", "description": "Name: Length(max = 512, error = TENANT_INVALID_NAME: Please provide a valid name with a length less than 512 characters, min = 0) " }, "canonical_name": { "type": "string", "description": "Canonical Name: Pattern(error = TENANT_INVALID_CANONICAL_NAME: Please provide a valid canonical name with a length less than 128 characters, e.g., mydomain.com, regexp = [0-9a-zA-Z\\\\.\\\\-_]{1,128}) " }, "id": { "type": "string", "description": "Id" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "string", "description": "Inactive" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "string", "description": "Disabled" }, "tenant_id": { "type": "string", "description": "Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" } }, "required": [ "tenant_id" ] }, "TenantV2N1": { "properties": { "pan_tenant_id": { "type": "string", "description": "Pan Tenant Id: Length(max = 32, TENANT_INVALID_PAN_IT_TENANT_ID, min = 0) Digits(fraction = 0, integer = 32, TENANT_INVALID_PAN_IT_TENANT_ID) " }, "pan_account_id": { "type": "string", "description": "Pan Account Id: Length(max = 32, TENANT_INVALID_PAN_CSP_ACCOUNT_ID, min = 0) " }, "region": { "type": "string", "description": "Region" }, "clients": { "type": "array", "description": "Clients: Valid ", "items": { "type": "string", "description": "Clients" } }, "is_support": { "type": "boolean", "description": "Is Support" }, "is_esp": { "type": "boolean", "description": "Is Esp" }, "provider_data": { "type": "array", "description": "Provider Data: Valid ", "items": { "$ref": "#/components/schemas/ProviderData" } }, "operator": { "description": "Operator", "$ref": "#/components/schemas/Operator" }, "password_policy": { "description": "Password Policy: Valid ", "$ref": "#/components/schemas/PasswordPolicy" }, "ipv4_list": { "type": "array", "description": "Ipv4 List: Valid ", "items": { "$ref": "#/components/schemas/IPv4Address" } }, "phone_numbers": { "type": "array", "description": "Phone Numbers: Valid ", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "address": { "description": "Address: Valid ", "$ref": "#/components/schemas/Address" }, "description": { "type": "string", "description": "Description: Length(max = 1024, error = TENANT_INVALID_DESCRIPTION: Please provide a description with a length less than 1024 characters, min = 0) " }, "name": { "type": "string", "description": "Name: Length(max = 512, error = TENANT_INVALID_NAME: Please provide a valid name with a length less than 512 characters, min = 0) " }, "canonical_name": { "type": "string", "description": "Canonical Name: Pattern(error = TENANT_INVALID_CANONICAL_NAME: Please provide a valid canonical name with a length less than 128 characters, e.g., mydomain.com, regexp = [0-9a-zA-Z\\\\.\\\\-_]{1,128}) " }, "id": { "type": "string", "description": "Id" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "string", "description": "Inactive" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "string", "description": "Disabled" }, "tenant_id": { "type": "string", "description": "Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" } }, "required": [ "tenant_id" ] }, "ErrorResponse": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "TsgInstance": { "properties": { "region": { "type": "string", "description": "Region" }, "app_id": { "type": "string", "description": "App Id" } } }, "SamlResponse": { "properties": { "relayState": { "type": "string", "description": "RelayState: MinLength(message = minLength, value = 1L) MaxLength(message = maxLength, value = 1000000L) " }, "samlResponse": { "type": "string", "description": "SamlResponse: Required(message = required) MinLength(message = minLength, value = 1L) MaxLength(message = maxLength, value = 1000000L) " } }, "required": [ "samlResponse" ] }, "PasswordPolicy": { "properties": { "enable_session_ip_lock": { "type": "boolean", "description": "Enable Session Ip Lock" }, "enable_failed_login_time_delay": { "type": "boolean", "description": "Enable Failed Login Time Delay" }, "failed_login_attempts": { "type": "integer" }, "enable_failed_login_attempts": { "type": "boolean", "description": "Enable Failed Login Attempts" }, "password_no_reuse_count": { "type": "integer" }, "enable_password_no_reuse_count": { "type": "boolean", "description": "Enable Password No Reuse Count" }, "enable_password_identity_difference": { "type": "boolean", "description": "Enable Password Identity Difference" }, "password_aging_notification": { "type": "integer" }, "password_aging_days": { "type": "integer" }, "enable_password_aging": { "type": "boolean", "description": "Enable Password Aging" }, "special_characters_regex": { "type": "string", "description": "Special Characters Regex: JsonIgnore(value = true) " }, "special_characters": { "type": "string", "description": "Special Characters: JsonIgnore(value = true) " }, "enable_two_special_characters": { "type": "boolean", "description": "Enable Two Special Characters" }, "enable_two_numbers": { "type": "boolean", "description": "Enable Two Numbers" }, "enable_two_lower_case_letters": { "type": "boolean", "description": "Enable Two Lower Case Letters" }, "enable_two_upper_case_letters": { "type": "boolean", "description": "Enable Two Upper Case Letters" }, "maximum_password_length": { "type": "integer" }, "enable_maximum_password_length": { "type": "boolean", "description": "Enable Maximum Password Length" }, "minimum_password_length": { "type": "integer" }, "enable_minimum_password_length": { "type": "boolean", "description": "Enable Minimum Password Length" } } }, "Protocol": {}, "SDWANAppConfigScreen": { "properties": { "user_config": { "type": "object" }, "state": { "type": "string", "description": "State: Required(SDWAN_APP_CONFIG_STATE_REQUIRED) ValidateEnum(enumClass = classOf[AppConfigState], message = SDWAN_APP_INVALID_APP_CONFIG_STATE, nullAllowed = false) ", "enum": [ "ENABLED", "DISABLED", "PAUSED" ] }, "version": { "type": "string", "description": "Version" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "state" ] }, "SDWANAppConfig": { "properties": { "user_config": { "type": "object" }, "state": { "type": "string", "description": "State: Required(SDWAN_APP_CONFIG_STATE_REQUIRED) ValidateEnum(enumClass = classOf[AppConfigState], message = SDWAN_APP_INVALID_APP_CONFIG_STATE, nullAllowed = false) ", "enum": [ "ENABLED", "DISABLED", "PAUSED" ] }, "version": { "type": "string", "description": "Version" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "state" ] }, "SDWANAppReleaseInfoResponseV2N2": { "properties": { "releases": { "type": "array", "description": "Releases", "items": { "$ref": "#/components/schemas/SDWANAppReleaseInfoV2N2" } }, "author": { "description": "Author", "$ref": "#/components/schemas/Author" }, "tags": { "type": "array", "description": "Tags", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description" }, "name": { "type": "string", "description": "Name" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "SDWANAppReleaseInfoResponseV2N1": { "properties": { "releases": { "type": "array", "description": "Releases", "items": { "$ref": "#/components/schemas/SDWANAppReleaseInfoV2N1" } }, "author": { "description": "Author: Required(SDWAN_APP_OWNER_REQUIRED) Valid ", "$ref": "#/components/schemas/Author" }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 128, listMaxSize = 10, INVALID_TAG, noTrim = false, regex = [^,\\\\s]+, required = false) ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 128, listMaxSize = 10, INVALID_TAG, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, DESCRIPTION_EXCEEDS_LIMIT, min = 0) Size(max = 256, DESCRIPTION_EXCEEDS_LIMIT, min = 0) " }, "name": { "type": "string", "description": "Name: Required(NAME_REQD) Size(max = 128, NAME_EXCEEDS_LIMIT, min = 0) Required(NAME_REQD) Size(max = 128, NAME_EXCEEDS_LIMIT, min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "author", "name" ] }, "Parameter": { "properties": { "display_label": { "type": "string", "description": "Display Label" }, "help_text": { "type": "string", "description": "Help Text" }, "sensitive": { "type": "boolean", "description": "Sensitive" }, "required": { "type": "boolean", "description": "Required" }, "regex": { "type": "string", "description": "Regex" }, "max_value": { "type": "object", "description": "Max Value" }, "min_value": { "type": "object", "description": "Min Value" }, "max_length": { "type": "integer", "description": "Max Length" }, "default_value": { "type": "object", "description": "Default Value" }, "type": { "type": "string", "description": "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" ] }, "key": { "type": "string", "description": "Key" } } }, "SDWANAppStatus": { "properties": { "details": { "type": "string", "description": "Details" }, "severity": { "type": "string", "description": "Severity: Required(error = SDWAN_APP_STATUS_SEVERITY_REQUIRED: Application Status severity required.) ValidateEnum(enumClass = classOf[Severity], message = SDWAN_APP_STATUS_INVALID_SEVERITY, nullAllowed = false) ", "enum": [ "INFO", "ERROR", "WARNING", "FATAL" ] }, "message": { "type": "string", "description": "Message: Required(error = SDWAN_APP_STATUS_MESSAGE_REQUIRED: Application Status message required.) " }, "timestamp": { "type": "integer", "description": "Timestamp: Required(error = SDWAN_APP_STATUS_TIMESTAMP_REQUIRED: Application status timestamp required.) ", "format": "int64" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "severity", "message", "timestamp" ] }, "SDWANAppParameter": { "properties": { "list_values": { "type": "array", "description": "List Values", "items": { "$ref": "#/components/schemas/SDWANAppParameterListValue" } }, "display_label": { "type": "string", "description": "Display Label" }, "help_text": { "type": "string", "description": "Help Text" }, "sensitive": { "type": "boolean", "description": "Sensitive" }, "required": { "type": "boolean", "description": "Required" }, "regex": { "type": "string", "description": "Regex" }, "max_value": { "type": "string", "description": "Max Value" }, "min_value": { "type": "string", "description": "Min Value" }, "max_length": { "type": "integer", "description": "Max Length" }, "default_value": { "type": "string", "description": "Default Value" }, "type": { "type": "string", "description": "Type: Required(SDWAN_APP_CONFIG_DATA_TYPE_REQUIRED) ValidateEnum(enumClass = classOf[DataType], message = SDWAN_APP_RELEASE_UNSUPPORTED_DATA_TYPE, nullAllowed = false) ", "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" ] }, "key": { "type": "string", "description": "Key: Required(SDWAN_APP_CONFIG_KEY_REQUIRED) " } }, "required": [ "type", "key" ] }, "SDWANAppReleaseInfo": { "properties": { "release_notes": { "type": "string", "description": "Release Notes" }, "default_release": { "type": "boolean", "description": "Default Release" }, "parameters": { "type": "array", "description": "Parameters", "items": { "$ref": "#/components/schemas/Parameter" } }, "permissions": { "type": "array", "description": "Permissions", "items": { "type": "string", "description": "Permissions" } }, "state": { "type": "string", "description": "State", "enum": [ "INIT", "ALPHA", "BETA", "GA", "DEPRECATED", "TO_BE_DELETED" ] }, "release_date": { "type": "integer", "description": "Release Date", "format": "int64" }, "version": { "type": "string", "description": "Version" }, "tags": { "type": "array", "description": "Tags", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description" }, "name": { "type": "string", "description": "Name" } } }, "SDWANAppReleaseInfoResponse": { "properties": { "releases": { "type": "array", "description": "Releases", "items": { "$ref": "#/components/schemas/SDWANAppReleaseInfo" } }, "author": { "description": "Author: Required(SDWAN_APP_OWNER_REQUIRED) Valid ", "$ref": "#/components/schemas/Author" }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 128, listMaxSize = 10, INVALID_TAG, noTrim = false, regex = [^,\\\\s]+, required = false) ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 128, listMaxSize = 10, INVALID_TAG, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, DESCRIPTION_EXCEEDS_LIMIT, min = 0) Size(max = 256, DESCRIPTION_EXCEEDS_LIMIT, min = 0) " }, "name": { "type": "string", "description": "Name: Required(NAME_REQD) Size(max = 128, NAME_EXCEEDS_LIMIT, min = 0) Required(NAME_REQD) Size(max = 128, NAME_EXCEEDS_LIMIT, min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "author", "name" ] }, "BulkResponse": { "properties": { "count": { "type": "integer", "format": "int32" }, "id": { "type": "string" }, "type": { "type": "string" } } }, "ParameterListValueResponse": { "properties": { "is_default": { "type": "boolean", "description": "Is Default" }, "display_label": { "type": "string", "description": "Display Label" }, "value": { "type": "object", "description": "Value" } } }, "SDWANAppParameterListValue": { "properties": { "is_default": { "type": "boolean", "description": "Is Default" }, "display_label": { "type": "string", "description": "Display Label" }, "value": { "type": "string", "description": "Value" } } }, "SDWANAppReleaseInfoV2N2": { "properties": { "auth_role": { "type": "string", "description": "Auth Role" }, "release_notes": { "type": "string", "description": "Release Notes" }, "default_release": { "type": "boolean", "description": "Default Release" }, "parameters": { "type": "array", "description": "Parameters", "items": { "$ref": "#/components/schemas/SDWANAppParameterResponse" } }, "permissions": { "type": "array", "description": "Permissions", "items": { "type": "string", "description": "Permissions" } }, "state": { "type": "string", "description": "State", "enum": [ "INIT", "ALPHA", "BETA", "GA", "DEPRECATED", "TO_BE_DELETED" ] }, "release_date": { "type": "integer", "description": "Release Date", "format": "int64" }, "version": { "type": "string", "description": "Version" }, "tags": { "type": "array", "description": "Tags", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description" }, "name": { "type": "string", "description": "Name" } } }, "SDWANAppRelease": { "properties": { "release_notes": { "type": "string", "description": "Release Notes: Size(max = 1024, RELEASE_NOTES_EXCEEDS_LIMIT, min = 0) " }, "default_release": { "type": "boolean", "description": "Default Release" }, "parameters": { "type": "array", "description": "Parameters: Required(SDWAN_APP_PARAMETERS_REQUIRED) Valid ", "items": { "$ref": "#/components/schemas/SDWANAppParameter" } }, "auth_role": { "type": "string", "description": "Auth Role" }, "permissions": { "type": "array", "description": "Permissions", "items": { "type": "string", "description": "Permissions" } }, "state": { "type": "string", "description": "State: Required(SDWAN_APP_STATE_REQUIRED) ValidateEnum(enumClass = classOf[AppState], message = SDWAN_APP_INVALID_APP_RELEASE_STATE, nullAllowed = false) ", "enum": [ "INIT", "ALPHA", "BETA", "GA", "DEPRECATED", "TO_BE_DELETED" ] }, "release_date": { "type": "integer", "description": "Release Date", "format": "int64" }, "version": { "type": "string", "description": "Version: Required(SDWAN_APP_VERSION_REQUIRED) Pattern(message = SDWAN_APP_INVALID_RELEASE_VERSION, regexp = ^([0-9]\\\\d*)\\\\.(\\\\d+)\\\\.(\\\\d+)(?:-[br][0-9]?\\\\d*)?$) " }, "application_id": { "type": "string", "description": "Application Id" }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 128, listMaxSize = 10, INVALID_TAG, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, DESCRIPTION_EXCEEDS_LIMIT, min = 0) " }, "name": { "type": "string", "description": "Name: Required(NAME_REQD) Size(max = 128, NAME_EXCEEDS_LIMIT, min = 0) " }, "region": { "type": "string", "description": "Region" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "boolean", "description": "Disabled" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "boolean", "description": "Inactive" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string" } }, "required": [ "parameters", "state", "version", "name" ] }, "SDWANAppReleaseInfoV2N1": { "properties": { "release_notes": { "type": "string", "description": "Release Notes" }, "default_release": { "type": "boolean", "description": "Default Release" }, "parameters": { "type": "array", "description": "Parameters", "items": { "$ref": "#/components/schemas/SDWANAppParameterResponse" } }, "permissions": { "type": "array", "description": "Permissions", "items": { "type": "string", "description": "Permissions" } }, "state": { "type": "string", "description": "State", "enum": [ "INIT", "ALPHA", "BETA", "GA", "DEPRECATED", "TO_BE_DELETED" ] }, "release_date": { "type": "integer", "description": "Release Date", "format": "int64" }, "version": { "type": "string", "description": "Version" }, "tags": { "type": "array", "description": "Tags", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description" }, "name": { "type": "string", "description": "Name" } } }, "SDWANAppParameterResponse": { "properties": { "list_values": { "type": "array", "description": "List Values", "items": { "$ref": "#/components/schemas/ParameterListValueResponse" } }, "display_label": { "type": "string", "description": "Display Label: Size(max = 128, error = SDWAN_APP_RELEASE_DISPLAY_LABEL_LENGTH_EXCEEDED: Maximum allowed length for display label is 128, min = 0) " }, "help_text": { "type": "string", "description": "Help Text: Size(max = 256, error = SDWAN_APP_RELEASE_HELP_TEXT_LENGTH_EXCEEDED: Maximum allowed length for help_text is 256, min = 0) " }, "sensitive": { "type": "boolean", "description": "Sensitive" }, "required": { "type": "boolean", "description": "Required" }, "regex": { "type": "string", "description": "Regex" }, "max_value": { "type": "object", "description": "Max Value" }, "min_value": { "type": "object", "description": "Min Value" }, "max_length": { "type": "integer", "description": "Max Length: Range(max = 4096L, error = SDWAN_APP_INVALID_MAX_LENGTH: Max length should be between 1-1024, min = 1L) " }, "default_value": { "type": "object", "description": "Default Value" }, "type": { "type": "string", "description": "Type: Required(message = SDWAN_APP_RELEASE_PARAMETER_TYPE_REQUIRED) ValidateEnum(enumClass = classOf[DataType], message = SDWAN_APP_RELEASE_UNSUPPORTED_DATA_TYPE, nullAllowed = false) ", "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" ] }, "key": { "type": "string", "description": "Key: Required(message = SDWAN_APP_RELEASE_PARAMETER_KEY_REQUIRED) " } }, "required": [ "type", "key" ] }, "Author": { "properties": { "email": { "type": "string", "description": "Email: Required(SDWAN_APP_AUTHOR_EMAIL_REQUIRED) Email(INVALID_AUTHOR_EMAIL) " }, "name": { "type": "string", "description": "Name: Required(SDWAN_APP_AUTHOR_NAME_REQUIRED) " } }, "required": [ "email", "name" ] }, "AuditLogV2N1": { "properties": { "sdwanapp_id": { "type": "string", "description": "Sdwanapp Id: Length(max = 128, , min = 0) " }, "response_ts": { "type": "integer", "description": "Response Ts", "format": "int64" }, "request_ts": { "type": "integer", "description": "Request Ts", "format": "int64" }, "response_content_length": { "type": "integer", "description": "Response Content Length", "format": "int32" }, "request_content_length": { "type": "integer", "description": "Request Content Length", "format": "int32" }, "time_ms": { "type": "integer", "description": "Time Ms", "format": "int64" }, "response_body": { "type": "string", "description": "Response Body: Length(max = 1048576, , min = 0) " }, "response_code": { "type": "integer", "description": "Response Code", "format": "int32" }, "request_body": { "type": "string", "description": "Request Body: Length(max = 1048576, , min = 0) " }, "request_uri": { "type": "string", "description": "Request Uri: Length(max = 4096, , min = 0) NotEmpty(AUDITLOG_REQUEST_URL_EMPTY) " }, "request_type": { "type": "string", "description": "Request Type: Length(max = 128, , min = 0) Pattern(message = AUDITLOG_REQUEST_TYPE_INVALID, regexp = (GET|POST|PUT|DELETE|PATCH)$) NotEmpty(AUDITLOG_REQUEST_TYPE_EMPTY) " }, "resource_version": { "type": "string", "description": "Resource Version: Length(max = 10, , min = 0) " }, "resource_etag": { "type": "integer", "description": "Resource Etag", "format": "int64" }, "resource_id": { "type": "string", "description": "Resource Id: Length(max = 50, , min = 0) " }, "resource_key": { "type": "string", "description": "Resource Key: Length(max = 128, , min = 0) " }, "source_ip": { "type": "string", "description": "Source Ip: ValidateHostName(allowNull = false, NTP_CONFIG_INVALID_HOST) " }, "request_id": { "type": "string", "description": "Request Id: Digits(fraction = 0, integer = 50, AUDITLOG_REQUEST_ID_INVALID) NotEmpty(AUDITLOG_REQUEST_ID_EMPTY) " }, "session_key_c": { "type": "string", "description": "Session Key C: Length(max = 128, , min = 0) " }, "esp_tenant_id": { "type": "string", "description": "Esp Tenant Id: Pattern(AUDITLOG_RESOURCE_ESP_TENANT_ID_INVALID, regexp = ^[a-z0-9]{1,50}$) " }, "operator_tenant_id": { "type": "string", "description": "Operator Tenant Id: Pattern(AUDITLOG_RESOURCE_TENANT_ID_INVALID, regexp = ^[a-z0-9]{1,50}$) " }, "operator_id": { "type": "string", "description": "Operator Id: Pattern(error = AUDITLOG_OPERATOR_ID_INVALID: Operator id is invalid, regexp = ^[a-z0-9@-]{1,50}$) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "request_uri", "request_type", "source_ip", "request_id" ] }, "AuditLog": { "properties": { "response_ts": { "type": "integer", "description": "Response Ts", "format": "int64" }, "request_ts": { "type": "integer", "description": "Request Ts", "format": "int64" }, "response_content_length": { "type": "integer", "description": "Response Content Length", "format": "int32" }, "request_content_length": { "type": "integer", "description": "Request Content Length", "format": "int32" }, "time_ms": { "type": "integer", "description": "Time Ms", "format": "int64" }, "response_body": { "type": "string", "description": "Response Body: Length(max = 1048576, , min = 0) " }, "response_code": { "type": "integer", "description": "Response Code", "format": "int32" }, "request_body": { "type": "string", "description": "Request Body: Length(max = 1048576, , min = 0) " }, "request_uri": { "type": "string", "description": "Request Uri: Length(max = 4096, , min = 0) NotEmpty(AUDITLOG_REQUEST_URL_EMPTY) " }, "request_type": { "type": "string", "description": "Request Type: Length(max = 128, , min = 0) Pattern(message = AUDITLOG_REQUEST_TYPE_INVALID, regexp = (GET|POST|PUT|DELETE|PATCH)$) NotEmpty(AUDITLOG_REQUEST_TYPE_EMPTY) " }, "resource_version": { "type": "string", "description": "Resource Version: Length(max = 10, , min = 0) " }, "resource_etag": { "type": "integer", "description": "Resource Etag", "format": "int64" }, "resource_id": { "type": "string", "description": "Resource Id: Length(max = 50, , min = 0) " }, "resource_key": { "type": "string", "description": "Resource Key: Length(max = 128, , min = 0) " }, "source_ip": { "type": "string", "description": "Source Ip: ValidateHostName(allowNull = false, NTP_CONFIG_INVALID_HOST) " }, "request_id": { "type": "string", "description": "Request Id: Digits(fraction = 0, integer = 50, AUDITLOG_REQUEST_ID_INVALID) NotEmpty(AUDITLOG_REQUEST_ID_EMPTY) " }, "session_key_c": { "type": "string", "description": "Session Key C: Length(max = 128, , min = 0) " }, "esp_tenant_id": { "type": "string", "description": "Esp Tenant Id: Pattern(AUDITLOG_RESOURCE_ESP_TENANT_ID_INVALID, regexp = ^[a-z0-9]{1,50}$) " }, "operator_tenant_id": { "type": "string", "description": "Operator Tenant Id: Pattern(AUDITLOG_RESOURCE_TENANT_ID_INVALID, regexp = ^[a-z0-9]{1,50}$) " }, "operator_id": { "type": "string", "description": "Operator Id: Pattern(error = AUDITLOG_OPERATOR_ID_INVALID: Operator id is invalid, regexp = ^[a-z0-9@-]{1,50}$) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "request_uri", "request_type", "source_ip", "request_id" ] }, "CorrelatedEvent": { "type": "object", "description": "Individual correlated event within a correlation event response", "properties": { "id": { "type": "string", "description": "Event identifier" }, "code": { "type": "string", "description": "Event code" }, "type": { "type": "string", "description": "Event type (alarm or alert)", "enum": [ "alarm", "alert" ] }, "priority": { "type": "string", "description": "Event priority", "enum": [ "p1", "p2", "p3", "p4", "p5" ] }, "severity": { "type": "string", "description": "Event severity" }, "time": { "type": "integer", "format": "int64", "description": "Event timestamp in milliseconds since epoch" }, "cleared": { "type": "boolean", "description": "Whether the event has been cleared" }, "acknowledged": { "type": "boolean", "description": "Whether the event has been acknowledged" } } }, "SiteCorrelationEventQueryResponse": { "type": "object", "description": "Site correlation event in query response.", "allOf": [ { "$ref": "#/components/schemas/SiteCorrelationEventResponse" } ] }, "AnynetlinkCorrelationEventQueryRequest": { "type": "object", "description": "Request body for querying AnynetLink correlation events", "allOf": [ { "$ref": "#/components/schemas/BaseQueryDTO" }, { "type": "object", "properties": { "anynetlink_id": { "type": "string", "description": "Filter by AnynetLink ID" } } } ] }, "SiteCorrelationEventQueryRequest": { "type": "object", "description": "Request body for querying site correlation events", "allOf": [ { "$ref": "#/components/schemas/BaseQueryDTO" }, { "type": "object", "properties": { "site_id": { "type": "string", "description": "Filter by site ID" } } } ] }, "ElementCorrelationEventResponse": { "type": "object", "description": "Element correlation event response.", "allOf": [ { "$ref": "#/components/schemas/CorrelationEventBase" }, { "type": "object", "properties": { "site_id": { "type": "string", "description": "Site identifier.\n\n[`Get sites`](https://pan.dev/sdwan/api/eir-sitev-4-n-13-getallsites-v-4-13/)\n" }, "element_id": { "type": "string", "description": "Element identifier.\n\n[`Get elements`](https://pan.dev/sdwan/api/eir-elementv-3-n-2-getelements-v-3-2/)\n" }, "element_name": { "type": "string", "description": "Element name." }, "correlated_events": { "type": "array", "description": "List of correlated events for this element.", "items": { "$ref": "#/components/schemas/CorrelatedEvent" } }, "standing_state": { "type": "string", "description": "Current standing state of the element." } } } ] }, "InterfaceCorrelationEventQueryResponse": { "type": "object", "description": "Interface correlation event in query response.", "allOf": [ { "$ref": "#/components/schemas/InterfaceCorrelationEventResponse" } ] }, "AnynetlinkCorrelationEventResponse": { "type": "object", "description": "AnynetLink correlation event response.", "allOf": [ { "$ref": "#/components/schemas/CorrelationEventBase" }, { "type": "object", "properties": { "anynetlink_id": { "type": "string", "description": "AnynetLink identifier.\n\n[`Get Anynet details`](https://pan.dev/sdwan/api/rhe-anynetlinkv-4-queryanynetlinks-v-4-0/)\n" }, "anynetlink_name": { "type": "string", "description": "AnynetLink name." }, "source_site_id": { "type": "string", "description": "Source site identifier.\n\n[`Get sites`](https://pan.dev/sdwan/api/eir-sitev-4-n-13-getallsites-v-4-13/)\n" }, "target_site_id": { "type": "string", "description": "Target site identifier.\n\n[`Get sites`](https://pan.dev/sdwan/api/eir-sitev-4-n-13-getallsites-v-4-13/)\n" }, "correlated_events": { "type": "array", "description": "List of correlated events for this AnynetLink.", "items": { "$ref": "#/components/schemas/CorrelatedEvent" } }, "standing_state": { "type": "string", "description": "Current standing state of the AnynetLink." } } } ] }, "ElementCorrelationEventQueryRequest": { "type": "object", "description": "Request body for querying element correlation events", "allOf": [ { "$ref": "#/components/schemas/BaseQueryDTO" }, { "type": "object", "properties": { "site_id": { "type": "string", "description": "Filter by site ID" }, "element_id": { "type": "string", "description": "Filter by element ID" } } } ] }, "SiteCorrelationEventResponse": { "type": "object", "description": "Site correlation event response.", "allOf": [ { "$ref": "#/components/schemas/CorrelationEventBase" }, { "type": "object", "properties": { "site_id": { "type": "string", "description": "Site identifier.\n\n[`Get sites`](https://pan.dev/sdwan/api/eir-sitev-4-n-13-getallsites-v-4-13/)\n" }, "site_name": { "type": "string", "description": "Site name." }, "correlated_events": { "type": "array", "description": "List of correlated events for this site.", "items": { "$ref": "#/components/schemas/CorrelatedEvent" } }, "standing_state": { "type": "string", "description": "Current standing state of the site." } } } ] }, "CorrelationEventSyncRequest": { "type": "object", "description": "Request body for syncing correlation events", "properties": { "resource_type": { "type": "string", "description": "Type of resource to sync correlation events for", "enum": [ "interface", "anynetlink", "waninterface", "site", "element" ] }, "force": { "type": "boolean", "description": "Force sync even if already in progress", "default": false } } }, "WANInterfaceCorrelationEventResponse": { "type": "object", "description": "WAN Interface correlation event response.", "allOf": [ { "$ref": "#/components/schemas/CorrelationEventBase" }, { "type": "object", "properties": { "site_id": { "type": "string", "description": "Site identifier.\n\n[`Get sites`](https://pan.dev/sdwan/api/eir-sitev-4-n-13-getallsites-v-4-13/)\n" }, "wan_interface_id": { "type": "string", "description": "WAN Interface identifier.\n\n[`Get WAN interface details`](https://pan.dev/sdwan/api/eir-waninterfacev-2-n-10-getinterfaces-v-2-10/)\n" }, "wan_interface_name": { "type": "string", "description": "WAN Interface name." }, "correlated_events": { "type": "array", "description": "List of correlated events for this WAN interface.", "items": { "$ref": "#/components/schemas/CorrelatedEvent" } }, "standing_state": { "type": "string", "description": "Current standing state of the WAN interface." } } } ] }, "WANInterfaceCorrelationEventQueryRequest": { "type": "object", "description": "Request body for querying WAN Interface correlation events", "allOf": [ { "$ref": "#/components/schemas/BaseQueryDTO" }, { "type": "object", "properties": { "site_id": { "type": "string", "description": "Filter by site ID" }, "wan_interface_id": { "type": "string", "description": "Filter by WAN interface ID" } } } ] }, "CorrelationEventBase": { "type": "object", "description": "Base fields common to all correlation events", "properties": { "id": { "type": "string", "description": "Unique identifier for the correlation event" }, "_created_on_utc": { "type": "integer", "format": "int64", "description": "Creation timestamp in milliseconds since epoch (UTC)" }, "_updated_on_utc": { "type": "integer", "format": "int64", "description": "Last update timestamp in milliseconds since epoch (UTC)" }, "_etag": { "type": "integer", "description": "Entity tag for optimistic locking" }, "_status_code": { "type": "string", "description": "HTTP status code" } } }, "ElementCorrelationEventQueryResponse": { "type": "object", "description": "Element correlation event in query response.", "allOf": [ { "$ref": "#/components/schemas/ElementCorrelationEventResponse" } ] }, "InterfaceCorrelationEventQueryRequest": { "type": "object", "description": "Request body for querying interface correlation events", "allOf": [ { "$ref": "#/components/schemas/BaseQueryDTO" }, { "type": "object", "properties": { "site_id": { "type": "string", "description": "Filter by site ID" }, "element_id": { "type": "string", "description": "Filter by element ID" }, "interface_id": { "type": "string", "description": "Filter by interface ID" } } } ] }, "CorrelationEventSyncResponse": { "type": "object", "description": "Response for correlation event sync operation", "properties": { "id": { "type": "string", "description": "Sync operation identifier" }, "status": { "type": "string", "description": "Sync operation status", "enum": [ "pending", "in_progress", "completed", "failed" ] }, "resource_type": { "type": "string", "description": "Resource type being synced" }, "started_at": { "type": "integer", "format": "int64", "description": "Sync start timestamp" }, "completed_at": { "type": "integer", "format": "int64", "description": "Sync completion timestamp" }, "records_processed": { "type": "integer", "description": "Number of records processed" }, "error_message": { "type": "string", "description": "Error message if sync failed" } } }, "InterfaceCorrelationEventResponse": { "type": "object", "description": "Interface correlation event response.", "allOf": [ { "$ref": "#/components/schemas/CorrelationEventBase" }, { "type": "object", "properties": { "site_id": { "type": "string", "description": "Site identifier.\n\n[`Get sites`](https://pan.dev/sdwan/api/eir-sitev-4-n-13-getallsites-v-4-13/)\n" }, "element_id": { "type": "string", "description": "Element identifier.\n\n[`Get elements`](https://pan.dev/sdwan/api/eir-elementv-3-n-2-getelements-v-3-2/)\n" }, "interface_id": { "type": "string", "description": "Interface identifier.\n\n[`Get interfaces`](https://pan.dev/sdwan/api/eir-baseinterfacemgr-getinterfaces-v-4-21/)\n" }, "interface_name": { "type": "string", "description": "Interface name." }, "correlated_events": { "type": "array", "description": "List of correlated events for this interface.", "items": { "$ref": "#/components/schemas/CorrelatedEvent" } }, "standing_state": { "type": "string", "description": "Current standing state of the interface." } } } ] }, "WANInterfaceCorrelationEventQueryResponse": { "type": "object", "description": "WAN Interface correlation event in query response.", "allOf": [ { "$ref": "#/components/schemas/WANInterfaceCorrelationEventResponse" } ] }, "PriorityPolicyRule": { "properties": { "priority_number": { "type": "integer", "description": "Priority Number: Required(error = INVALID_PRIORITY_NUMBER: Invalid priority number.) Min(error = PRIORITY_NUMBER_MINIMUM_VAL: Priority number should not be less than 1., value = 1L) Max(error = PRIORITY_NUMBER_MAXIMUM_VAL: Priority number should not be greater than 4., value = 4L) ", "format": "int32" }, "dscp": { "description": "Dscp: Valid ", "$ref": "#/components/schemas/DSCP" }, "destination_prefixes_id": { "type": "string", "description": "Destination Prefixes Id: Digits(fraction = 0, integer = 30, error = INVALID_DESTINATION_PREFIXES_ID: Specified destination prefix is invalid.) " }, "source_prefixes_id": { "type": "string", "description": "Source Prefixes Id: Digits(fraction = 0, integer = 30, error = INVALID_SOURCE_PREFIXES_ID: Specified source prefix is invalid.) " }, "enabled": { "type": "boolean", "description": "Enabled" }, "order_number": { "type": "integer", "description": "Order Number: Min(error = INVALID_ORDER_NUMBER_MINIMUM_VAL: Policy Rule order number should not be less than 1., value = 1L) Max(error = INVALID_ORDER_NUMBER_MAXIMUM_VAL: Policy Rule order number should not be greater than 65535., value = 65535L) " }, "network_context_id": { "type": "string", "description": "Network Context Id: Digits(fraction = 0, integer = 30, error = INVALID_NETWORK_CONTEXT_ID: Specified network context is invalid.) " }, "app_def_ids": { "type": "array", "description": "App Def Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, error = DUPLICATE_APP_DEF_IDS: Duplicate app ids are specified., noTrim = false, regex = , required = false) Size(max = 256, error = APP_DEF_ID_LIST_SIZE_EXCEEDED: Maximum 256 applications can be specified in a rule., min = 0) ", "items": { "type": "string", "description": "App Def Ids" } }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "priority_number", "name" ] }, "IPFixGlobalPrefixScreen": { "properties": { "ipv4_prefixes": { "type": "array", "description": "Ipv4 Prefixes: ListIPAddress(bcast = DENY, listMaxSize = 0, error = INVALID_PREFIX: Prefix is not valid OR not within the valid prefix range., required = false, type = PREFIXCIDR_ALL) ", "items": { "type": "string", "description": "Ipv4 Prefixes" } }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "ActiveUserIPQueryFilter": { "properties": { "valid_until": { "type": "integer", "description": "Valid Until", "format": "int64" }, "user_id": { "type": "string", "description": "User Id" }, "username": { "type": "string", "description": "Username: NotEmpty " }, "ip": { "type": "string", "description": "Ip: NotEmpty " }, "site_id": { "type": "string", "description": "Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) NotNull " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "username", "ip", "site_id" ] }, "WANNetworkQuery": { "properties": { "isReadPreferenceSecondary": { "type": "boolean", "description": "IsReadPreferenceSecondary: JsonIgnore(value = true) " }, "last_query_ts": { "type": "integer", "description": "Last Query Ts", "format": "int64" }, "getDeleted": { "type": "boolean", "description": "GetDeleted" }, "aggregate": { "description": "Aggregate", "$ref": "#/components/schemas/Aggregate" }, "group_by": { "type": "array", "description": "Group By", "items": { "type": "string", "description": "Group By" } }, "retrieved_fields": { "type": "array", "description": "Retrieved Fields", "items": { "type": "string", "description": "Retrieved Fields" } }, "retrieved_fields_mask": { "type": "boolean", "description": "Retrieved Fields Mask" }, "total_count": { "type": "integer", "description": "Total Count", "format": "int64" }, "dest_page": { "type": "integer", "description": "Dest Page", "format": "int32" }, "next_query": { "type": "object" }, "limit": { "type": "integer", "description": "Limit", "format": "int32" }, "sort_case_insensitive": { "type": "boolean", "description": "Sort Case Insensitive" }, "sort_params": { "type": "object" }, "query_params": { "type": "object" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "ElemCacheConfig": { "properties": { "cache_size": { "type": "integer", "description": "Cache Size: Range(max = 9223372036854775807L, error = INVALID_CACHE_SIZE_RANGE: Invalid cache size, must be positive value, min = 0L) ", "format": "int32" } } }, "MulticastWanStatusQueryFilter": { "properties": { "pim_neighbors": { "type": "array", "description": "Pim Neighbors: Valid ListObject(allowDuplicate = true, allowEmpty = true, allowNull = true, listMaxSize = 420, message = MULTICAST_WAN_NEIGHBOR_EXCEEDS_LIMIT, required = false) ", "items": { "$ref": "#/components/schemas/MulticastWanNeighbor" } }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "DeviceIdConfig": { "properties": { "cfg_device_id_enabled": { "type": "boolean", "description": "Cfg Device Id Enabled" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "IPFixLocalPrefixScreen": { "properties": { "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "SecurityPolicyV2SetScreen": { "properties": { "policyrule_order": { "type": "array", "description": "Policyrule Order", "items": { "type": "string", "description": "Policyrule Order" } }, "defaultrule_policyset": { "type": "boolean", "description": "Defaultrule Policyset" }, "clone_from": { "type": "string", "description": "Clone From: Digits(fraction = 0, integer = 20, INVALID_CLONE_FROM) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "PriorityPolicySet": { "properties": { "template": { "type": "boolean", "description": "Template" }, "default_rule_dscp_mappings": { "type": "array", "description": "Default Rule Dscp Mappings: Valid Size(max = 16, message = INVALID_DSCP_MAPPINGS, min = 0) ", "items": { "$ref": "#/components/schemas/DefaultRuleDSCPMapping" } }, "business_priority_names": { "type": "array", "description": "Business Priority Names: Required(error = BUSINESS_PRIORITY_NAMES_REQD: Business priority names required.) Size(max = 4, error = BUSINESS_PRIORITY_NAME_LIST_SIZE_EXCEEDED: Business priority name list exceeds the limit of 4., min = 0) Valid ", "items": { "$ref": "#/components/schemas/BusinessPriorityNameMapper" } }, "bandwidth_allocation_schemes": { "type": "array", "description": "Bandwidth Allocation Schemes: Required(error = BANDWIDTH_ALLOCATION_SCHEME_REQD: Please provide Bandwidth Allocation scheme for set.) Size(max = 4, error = BANDWIDTH_ALLOCATION_SCHEME_LIST_SIZE_EXCEEDED: Bandwidth Allocation scheme list exceeds the limit of 4., min = 0) Valid ", "items": { "$ref": "#/components/schemas/BandwidthAllocationSchemeV2" } }, "defaultrule_policyset": { "type": "boolean", "description": "Defaultrule Policyset" }, "clone_from": { "type": "string", "description": "Clone From: Digits(fraction = 0, integer = 20, INVALID_CLONE_FROM) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "business_priority_names", "bandwidth_allocation_schemes", "name" ] }, "CustomDHCPOptions": { "properties": { "vendor_class_identifier": { "type": "string", "description": "Vendor Class Identifier" }, "option_value": { "type": "string", "description": "Option Value: NotEmpty(groups = [classOf[Value]], error = DHCPSERVER_CONFIG_CUSTOM_OPTIONS_VAL_UNSUPPORTED: Custom option value is not supported) Size(groups = [classOf[Value]], max = 8192, error = DHCPSERVER_CONFIG_OPTION_VAL_EXCEEDS_LIMIT: Custom option value length exceeds maximum limit, min = 0) " }, "option_definition": { "type": "string", "description": "Option Definition: NotEmpty(groups = [classOf[Definition]], error = DHCPSERVER_CONFIG_CUSTOM_OPTIONS_DEF_UNSUPPORTED: Custom option definition is not supported) Size(groups = [classOf[Definition]], max = 1024, error = DHCPSERVER_CONFIG_OPTION_DEF_EXCEEDS_LIMIT: Custom option definition length exceeeds maximum limit, min = 0) " } }, "required": [ "option_value", "option_definition" ] }, "ElementAggregateQueryFilterV2N5": { "properties": { "connected": { "type": "boolean", "description": "Connected" }, "aggregated_value": { "type": "integer", "description": "Aggregated Value", "format": "int64" }, "fips_mode_change_start_time": { "type": "integer", "description": "Fips Mode Change Start Time", "format": "int64" }, "fips_mode": { "type": "string", "description": "Fips Mode", "enum": [ "none", "fips", "non_fips" ] }, "admin_suspend_state": { "type": "string", "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" ] }, "spoke_ha_config": { "description": "Spoke Ha Config: Valid ", "$ref": "#/components/schemas/SpokeHAConfigV2" }, "admin_renew_state": { "type": "string", "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" ] }, "vpn_to_vpn_forwarding": { "type": "boolean", "description": "Vpn To Vpn Forwarding" }, "nat_policysetstack_id": { "type": "string", "description": "Nat Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "priority_policysetstack_id": { "type": "string", "description": "Priority Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy set stack id) " }, "network_policysetstack_id": { "type": "string", "description": "Network Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy set stack id) " }, "deployment_op": { "type": "string", "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" ] }, "admin_action": { "type": "string", "description": "Admin Action", "enum": [ "ALLOCATE", "CLAIM", "BOUND", "UNBOUND", "DECLAIM", "RETURN", "REVOKE", "RETIRE", "STOCK", "UPGRADE", "REMANUFACTURE", "DEFAULT", "INVALID" ] }, "l3_lan_forwarding": { "type": "boolean", "description": "L3 Lan Forwarding" }, "l3_direct_private_wan_forwarding": { "type": "boolean", "description": "L3 Direct Private Wan Forwarding" }, "cluster_member_id": { "type": "string", "description": "Cluster Member Id" }, "cluster_insertion_mode": { "type": "string", "description": "Cluster Insertion Mode" }, "allowed_roles": { "type": "array", "description": "Allowed Roles", "items": { "type": "string", "description": "Allowed Roles", "enum": [ "NONE", "HUB", "SPOKE", "PA_WE_BR", "PA_WE_DC", "PA_CONN" ] } }, "state": { "type": "string", "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", "ACTIVE_DECLAIMED" ] }, "role": { "type": "string", "description": "Role", "enum": [ "NONE", "HUB", "SPOKE", "PA_WE_BR", "PA_WE_DC", "PA_CONN" ] }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "model_name": { "type": "string", "description": "Model Name" }, "serial_number": { "type": "string", "description": "Serial Number" }, "hw_id": { "type": "string", "description": "Hw Id" }, "software_version": { "type": "string", "description": "Software Version" }, "site_id": { "type": "string", "description": "Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) NotNull " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "site_id" ] }, "Certificate": { "properties": { "passphrase": { "type": "string", "description": "Passphrase" }, "key_file": { "type": "string", "description": "Key File" }, "ca": { "type": "boolean", "description": "Ca" }, "subject_hash": { "type": "string", "description": "Subject Hash" }, "subject": { "type": "string", "description": "Subject: NotNull(message = INVALID_SUBJECT) " }, "not_valid_before": { "type": "string", "description": "Not Valid Before" }, "not_valid_after": { "type": "string", "description": "Not Valid After" }, "issuer_hash": { "type": "string", "description": "Issuer Hash" }, "issuer": { "type": "string", "description": "Issuer: NotNull(message = INVALID_ISSUER) " }, "algorithm": { "type": "string", "description": "Algorithm" }, "used_for": { "type": "array", "description": "Used For: ListEnum(enumClass = classOf[CertificateUsage], length = 0, listMaxSize = 3, error = CERTIFICATE_USED_FOR_INVALID: Invalid certificate used_for value., nullAllowed = false) ", "items": { "type": "string", "description": "Used For", "enum": [ "FORWARD_TRUST_CERTIFICATE", "FORWARD_UNTRUST_CERTIFICATE", "TRUSTED_ROOT_CA" ] } }, "has_passphrase": { "type": "boolean", "description": "Has Passphrase" }, "has_key_file": { "type": "boolean", "description": "Has Key File" }, "certificate_file": { "type": "string", "description": "Certificate File" }, "format": { "type": "string", "description": "Format: Required(error = CERTIFICATE_FORMAT_INVALID: Invalid certificate format.) ", "enum": [ "PEM", "PKCS12" ] }, "name": { "type": "string", "description": "Name: Required(error = CERTIFICATE_NAME_INVALID: Please provide certificate name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "region": { "type": "string", "description": "Region" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "boolean", "description": "Disabled" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "boolean", "description": "Inactive" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" }, "revocation_date": { "type": "integer", "description": "Revocation Date", "format": "int64" }, "revocation_reason": { "type": "string", "description": "Revocation Reason" }, "revoked": { "type": "boolean", "description": "Revoked" }, "certificate": { "type": "string", "description": "Certificate" }, "not_after": { "type": "integer", "description": "Not After", "format": "int64" }, "public_key": { "type": "string", "description": "Public Key: Size(max = 2048, message = INVALID_PUBLIC_KEY, min = 0) " }, "not_before": { "type": "integer", "description": "Not Before", "format": "int64" }, "issuer_id": { "type": "string", "description": "Issuer Id: NotNull(message = INVALID_ISSUER_ID) " }, "subj_descr": { "type": "string", "description": "Subj Descr" }, "subj_uid": { "type": "string", "description": "Subj Uid" }, "title": { "type": "string", "description": "Title" }, "entity_id": { "type": "string", "description": "Entity Id: NotNull(message = INVALID_ENTITY_ID) " }, "subj_serial_no": { "type": "string", "description": "Subj Serial No" }, "serial_no": { "type": "string", "description": "Serial No: NotNull(message = INVALID_SERIAL_NO) " } }, "required": [ "format", "subject", "issuer_id", "name", "used_for", "issuer", "serial_no", "entity_id" ] }, "PerfMgmtPolicySetState": { "properties": { "policy_req_state": { "type": "string", "description": "Policy Req State", "enum": [ "POLICY_REQ_PENDING", "POLICY_CREATE_INPROGRESS", "POLICY_CREATE_COMPLETE", "POLICY_REPLICATE", "POLICY_CREATE_FAILED", "POLICY_REQ_COMPLETE" ] }, "policyset_id": { "type": "string", "description": "Policyset Id" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "WANInterfaceScreenV2N8": { "properties": { "probe_profile_id": { "type": "string", "description": "Probe Profile Id" }, "l3_reachability": { "description": "L3 Reachability: Valid ", "$ref": "#/components/schemas/WANL3Reachability" }, "bwc_enabled": { "type": "boolean", "description": "Bwc Enabled" }, "use_lqm_for_non_hub_paths": { "type": "boolean", "description": "Use Lqm For Non Hub Paths" }, "lqm_enabled": { "type": "boolean", "description": "Lqm Enabled" }, "use_for_application_reachability_probes": { "type": "boolean", "description": "Use For Application Reachability Probes: Valid " }, "use_for_controller_connections": { "type": "boolean", "description": "Use For Controller Connections: Valid " }, "type": { "type": "string", "description": "Type", "enum": [ "PUBLIC_WAN", "PRIVATE_WAN" ] }, "vpnlink_configuration": { "description": "Vpnlink Configuration: Valid Valid Nullable ", "$ref": "#/components/schemas/VPNLinkConfiguration" }, "lqm_config": { "description": "Lqm Config: Valid ", "$ref": "#/components/schemas/LQMConfig" }, "cost": { "type": "integer", "description": "Cost: Range(max = 1024L, error = WANINTERFACE_INVALID_COST_VALUE: Cost value for site WAN interface should be within range 0-1024, min = 0L) " }, "label_id": { "type": "string", "description": "Label Id: NotEmpty(message = WAN_INTERFACE_INVALID_LABEL) " }, "bfd_mode": { "type": "string", "description": "Bfd Mode: ValidateEnum(enumClass = classOf[BfdMode], WAN_CONFIG_INVALID_BFD_MODE, nullAllowed = false) ", "enum": [ "aggressive", "non_aggressive" ] }, "bw_config_mode": { "type": "string", "description": "Bw Config Mode: ValidateEnum(enumClass = classOf[BWConfigMode], message = INVALID_BANDWIDTH_CONFIG_MODE, nullAllowed = false) ", "enum": [ "auto", "manual", "manual_bwm_disabled" ] }, "link_bw_up": { "type": "number", "description": "Link Bw Up: JsonIgnore(value = true) ", "format": "double" }, "link_bw_down": { "type": "number", "description": "Link Bw Down: JsonIgnore(value = true) ", "format": "double" }, "network_id": { "type": "string", "description": "Network Id: NotEmpty(message = NETWORK_ID_REQD) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, WANINTERFACE_CONFIG_DESCRIPTION_EXCEEDS_LIMIT, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, WANINTERFACE_CONFIG_NAME_EXCEEDS_LIMIT, min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "label_id", "bfd_mode", "bw_config_mode", "network_id" ] }, "WANInterfaceScreenV2N9": { "properties": { "lqm_config": { "description": "Lqm Config", "$ref": "#/components/schemas/LQMConfig" }, "probe_profile_id": { "type": "string", "description": "Probe Profile Id" }, "l3_reachability": { "description": "L3 Reachability: Valid ", "$ref": "#/components/schemas/WANL3Reachability" }, "bwc_enabled": { "type": "boolean", "description": "Bwc Enabled" }, "use_lqm_for_non_hub_paths": { "type": "boolean", "description": "Use Lqm For Non Hub Paths" }, "lqm_enabled": { "type": "boolean", "description": "Lqm Enabled" }, "use_for_application_reachability_probes": { "type": "boolean", "description": "Use For Application Reachability Probes: Valid " }, "use_for_controller_connections": { "type": "boolean", "description": "Use For Controller Connections: Valid " }, "type": { "type": "string", "description": "Type", "enum": [ "PUBLIC_WAN", "PRIVATE_WAN" ] }, "vpnlink_configuration": { "description": "Vpnlink Configuration: Valid Valid Nullable ", "$ref": "#/components/schemas/VPNLinkConfiguration" }, "cost": { "type": "integer", "description": "Cost: Range(max = 1024L, error = WANINTERFACE_INVALID_COST_VALUE: Cost value for site WAN interface should be within range 0-1024, min = 0L) " }, "label_id": { "type": "string", "description": "Label Id: NotEmpty(message = WAN_INTERFACE_INVALID_LABEL) " }, "bfd_mode": { "type": "string", "description": "Bfd Mode: ValidateEnum(enumClass = classOf[BfdMode], WAN_CONFIG_INVALID_BFD_MODE, nullAllowed = false) ", "enum": [ "aggressive", "non_aggressive" ] }, "bw_config_mode": { "type": "string", "description": "Bw Config Mode: ValidateEnum(enumClass = classOf[BWConfigMode], message = INVALID_BANDWIDTH_CONFIG_MODE, nullAllowed = false) ", "enum": [ "auto", "manual", "manual_bwm_disabled" ] }, "link_bw_up": { "type": "number", "description": "Link Bw Up: JsonIgnore(value = true) ", "format": "double" }, "link_bw_down": { "type": "number", "description": "Link Bw Down: JsonIgnore(value = true) ", "format": "double" }, "network_id": { "type": "string", "description": "Network Id: NotEmpty(message = NETWORK_ID_REQD) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, WANINTERFACE_CONFIG_DESCRIPTION_EXCEEDS_LIMIT, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, WANINTERFACE_CONFIG_NAME_EXCEEDS_LIMIT, min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "label_id", "bfd_mode", "bw_config_mode", "network_id" ] }, "LANNetworkScreenV3N2": { "properties": { "ipv6_config": { "description": "Ipv6 Config: Valid ", "$ref": "#/components/schemas/LanNetworkIPv6Config" }, "network_context_id": { "type": "string", "description": "Network Context Id: Digits(fraction = 0, integer = 30, error = INVALID_NETWORK_CONTEXT_ID: Specified network context is invalid.) " }, "ipv4_config": { "description": "Ipv4 Config: Valid ", "$ref": "#/components/schemas/LanNetworkIPv4Config" }, "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 1024, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "scope", "name" ] }, "LANNetworkScreenV3N1": { "properties": { "network_context_id": { "type": "string", "description": "Network Context Id: Digits(fraction = 0, integer = 30, error = INVALID_NETWORK_CONTEXT_ID: Specified network context is invalid.) " }, "ipv4_config": { "description": "Ipv4 Config: Valid ", "$ref": "#/components/schemas/LanNetworkIPv4Config" }, "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 1024, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "scope", "name" ] }, "LANNetworkScreenV3N3": { "properties": { "vrf_context_id": { "type": "string", "description": "Vrf Context Id: Digits(fraction = 0, integer = 20, error = VRF_CONTEXT_ID_INVALID: VRF Context ID is empty or invalid.) " }, "ipv6_config": { "description": "Ipv6 Config: Valid ", "$ref": "#/components/schemas/LanNetworkIPv6Config" }, "network_context_id": { "type": "string", "description": "Network Context Id: Digits(fraction = 0, integer = 30, error = INVALID_NETWORK_CONTEXT_ID: Specified network context is invalid.) " }, "ipv4_config": { "description": "Ipv4 Config: Valid ", "$ref": "#/components/schemas/LanNetworkIPv4Config" }, "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 1024, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "scope", "name" ] }, "TacacsPlusServerScreen": { "properties": { "authentication_protocol": { "type": "string", "description": "Authentication Protocol: ValidateEnum(enumClass = classOf[TacacsAuthenticationProtocolEnum], error = TACACS_PLUS_SERVER_INVALID_PROTOCOL: Invalid authentication protocol value. Should be either pap or chap., nullAllowed = true) " }, "tacacs_plus_servers": { "type": "array", "description": "Tacacs Plus Servers: Valid ListObject(allowDuplicate = true, allowEmpty = true, allowNull = true, listMaxSize = 4, error = TACACS_PLUS_SERVER_REQUIRED_SERVERS: Invalid number of TACACS servers configured. Minimum: 1 Maximum 4, required = false) ", "items": { "$ref": "#/components/schemas/TacacsPlusServerConfig" } }, "enabled": { "type": "boolean", "description": "Enabled" }, "source_interface_id": { "type": "string", "description": "Source Interface Id" }, "tacacs_plus_profile_id": { "type": "string", "description": "Tacacs Plus Profile Id" }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 1024, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "AppDefScreenV2N5": { "properties": { "p_parent_id": { "type": "string", "description": "P Parent Id" }, "supported_engines": { "type": "string", "description": "Supported Engines: ValidateEnum(enumClass = classOf[SupportedEngines], error = APPDEF_CONFIG_INVALID_CATEGORY: Application category is invalid., nullAllowed = true) ", "enum": [ "ave", "ave-all", "panos", "all", "panos-ml7" ] }, "p_sub_category": { "type": "string", "description": "P Sub Category: ValidateEnum(enumClass = classOf[PAppSubCategory], error = APPDEF_CONFIG_INVALID_CATEGORY: Application category is invalid., nullAllowed = true) " }, "p_category": { "type": "string", "description": "P Category: ValidateEnum(enumClass = classOf[PAppCategory], error = APPDEF_CONFIG_INVALID_CATEGORY: Application category is invalid., nullAllowed = true) " }, "network_scan_application": { "type": "boolean", "description": "Network Scan Application" }, "app_unreachability_detection": { "type": "boolean", "description": "App Unreachability Detection" }, "use_parentapp_network_policy": { "type": "boolean", "description": "Use Parentapp Network Policy" }, "parent_id": { "type": "string", "description": "Parent Id" }, "is_deprecated": { "type": "boolean", "description": "Is Deprecated" }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "system_app_overridden": { "type": "boolean", "description": "System App Overridden" }, "overrides_allowed": { "type": "boolean", "description": "Overrides Allowed" }, "order_number": { "type": "integer", "description": "Order Number: Range(max = 65535L, error = APPDEF_CONFIG_INVALID_ORDER_NUMBER: Order number should be between 1-65535, min = 1L) ", "format": "int32" }, "aggregate_flows": { "type": "boolean", "description": "Aggregate Flows" }, "session_timeout": { "type": "integer", "description": "Session Timeout: Range(max = 44000L, error = APPDEF_CONFIG_INVALID_SESSION_TIMEOUT: Application session timeout should be in between 0-44000, min = 0L) ", "format": "int32" }, "category": { "type": "string", "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" ] }, "app_type": { "type": "string", "description": "App Type", "enum": [ "custom" ] }, "transfer_type": { "type": "string", "description": "Transfer Type", "enum": [ "transactional", "bulk", "rt-audio", "rt-video" ] }, "ip_rules": { "type": "array", "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" } }, "udp_rules": { "type": "array", "description": "Udp 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" } }, "tcp_rules": { "type": "array", "description": "Tcp 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": "string" } }, "domains": { "type": "array", "description": "Domains: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 256, listMaxSize = 16, error = APPDEF_CONFIG_INVALID_DOMAIN_LIST: Application domain list is invalid. Maximum 16 valid domains are allowed and each domain should not exceed 253 characters., noTrim = false, regex = (?=^.{4,253}$)((^((?!-)[a-zA-Z0-9-]{1,63}(?= stp_max_age., min = 4L) ", "format": "int32" }, "stp_hello_time": { "type": "integer", "description": "Stp Hello Time: Range(max = 10L, error = INVALID_STP_HELLO_TIME: Invalid STP hello time. Allowed range is 1-10., min = 1L) ", "format": "int32" }, "stp_aging_timer": { "type": "integer", "description": "Stp Aging Timer: Range(max = 1000000L, error = INVALID_STP_AGING_TIMER: Invalid STP aging timer. Allowed range is 10-1000000., min = 10L) ", "format": "int32" }, "stp_max_age": { "type": "integer", "description": "Stp Max Age: Range(max = 40L, error = INVALID_STP_MAX_AGE: Invalid STP max age. Allowed range is 6-40., min = 6L) ", "format": "int32" }, "stp_mode": { "type": "string", "description": "Stp Mode: ValidateEnum(enumClass = classOf[STPMode], error = INVALID_STP_MODE: Invalid STP mode. Allowed values are stp, rstp or mstp., nullAllowed = false) ", "enum": [ "RSTP" ] }, "default_vlan_id": { "type": "integer", "description": "Default Vlan Id: Range(max = 4000L, error = INVALID_VLAN_ID: Invalid VLAN id. VLAN id must be between 1-4000., min = 1L) ", "format": "int32" }, "mstp_enabled": { "type": "boolean", "description": "Mstp Enabled" } }, "required": [ "stp_mode" ] }, "InterfaceV4N5": { "properties": { "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "service_link_config": { "description": "Service Link Config: Valid Valid ", "$ref": "#/components/schemas/ServiceLinkV1" }, "bypass_pair": { "description": "Bypass Pair", "$ref": "#/components/schemas/BypassPairV2" }, "network_context_id": { "type": "string", "description": "Network Context Id" }, "parent": { "type": "string", "description": "Parent" }, "pppoe_config": { "description": "Pppoe Config: Valid Valid ", "$ref": "#/components/schemas/PppoE" }, "sub_interface": { "description": "Sub Interface: Valid ", "$ref": "#/components/schemas/SubInterface" }, "bound_interfaces": { "type": "array", "description": "Bound Interfaces", "items": { "type": "string", "description": "Bound Interfaces" } }, "used_for": { "type": "string", "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) " }, "nat_port": { "type": "integer", "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" }, "nat_address": { "type": "string", "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) " }, "admin_up": { "type": "boolean", "description": "Admin Up" }, "ethernet_port": { "description": "Ethernet Port", "$ref": "#/components/schemas/EthernetPort" }, "dhcp_relay": { "description": "Dhcp Relay: Valid ", "$ref": "#/components/schemas/DHCPRelay" }, "ipv4_config": { "description": "Ipv4 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv4Config" }, "mtu": { "type": "integer", "description": "Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: MTU is not in the valid range., min = 0L) " }, "mac_address": { "type": "string", "description": "Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) " }, "site_wan_interface_ids": { "type": "array", "description": "Site Wan Interface Ids", "items": { "type": "string", "description": "Site Wan Interface Ids" } }, "attached_lan_networks": { "type": "array", "description": "Attached Lan Networks: Valid ", "items": { "$ref": "#/components/schemas/LanNetworkVlanMapping" } }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[InterfaceType], error = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "scope", "used_for", "type" ] }, "InterfaceV4N6": { "properties": { "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "service_link_config": { "description": "Service Link Config: Valid Valid ", "$ref": "#/components/schemas/ServiceLinkV1" }, "bypass_pair": { "description": "Bypass Pair", "$ref": "#/components/schemas/BypassPairV2" }, "network_context_id": { "type": "string", "description": "Network Context Id" }, "parent": { "type": "string", "description": "Parent" }, "pppoe_config": { "description": "Pppoe Config: Valid Valid ", "$ref": "#/components/schemas/PppoE" }, "sub_interface": { "description": "Sub Interface: Valid ", "$ref": "#/components/schemas/SubInterface" }, "bound_interfaces": { "type": "array", "description": "Bound Interfaces", "items": { "type": "string", "description": "Bound Interfaces" } }, "used_for": { "type": "string", "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) " }, "nat_port": { "type": "integer", "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" }, "nat_address": { "type": "string", "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) " }, "admin_up": { "type": "boolean", "description": "Admin Up" }, "ethernet_port": { "description": "Ethernet Port", "$ref": "#/components/schemas/EthernetPort" }, "dhcp_relay": { "description": "Dhcp Relay: Valid ", "$ref": "#/components/schemas/DHCPRelay" }, "ipv4_config": { "description": "Ipv4 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv4Config" }, "mtu": { "type": "integer", "description": "Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: MTU is not in the valid range., min = 0L) " }, "mac_address": { "type": "string", "description": "Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) " }, "site_wan_interface_ids": { "type": "array", "description": "Site Wan Interface Ids", "items": { "type": "string", "description": "Site Wan Interface Ids" } }, "attached_lan_networks": { "type": "array", "description": "Attached Lan Networks: Valid ", "items": { "$ref": "#/components/schemas/LanNetworkVlanMapping" } }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[InterfaceType], error = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "scope", "used_for", "type" ] }, "InterfaceV4N7": { "properties": { "nat_pools": { "type": "array", "description": "Nat Pools: Valid ", "items": { "$ref": "#/components/schemas/NatPool" } }, "devicemgmt_policysetstack_id": { "type": "string", "description": "Devicemgmt Policysetstack Id: Digits(fraction = 0, integer = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) " }, "nat_zone_id": { "type": "string", "description": "Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "service_link_config": { "description": "Service Link Config: Valid Valid ", "$ref": "#/components/schemas/ServiceLinkV1" }, "bypass_pair": { "description": "Bypass Pair", "$ref": "#/components/schemas/BypassPairV2" }, "network_context_id": { "type": "string", "description": "Network Context Id" }, "parent": { "type": "string", "description": "Parent" }, "pppoe_config": { "description": "Pppoe Config: Valid Valid ", "$ref": "#/components/schemas/PppoE" }, "sub_interface": { "description": "Sub Interface: Valid ", "$ref": "#/components/schemas/SubInterface" }, "bound_interfaces": { "type": "array", "description": "Bound Interfaces", "items": { "type": "string", "description": "Bound Interfaces" } }, "used_for": { "type": "string", "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) " }, "nat_port": { "type": "integer", "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" }, "nat_address": { "type": "string", "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) " }, "admin_up": { "type": "boolean", "description": "Admin Up" }, "ethernet_port": { "description": "Ethernet Port", "$ref": "#/components/schemas/EthernetPort" }, "dhcp_relay": { "description": "Dhcp Relay: Valid ", "$ref": "#/components/schemas/DHCPRelay" }, "ipv4_config": { "description": "Ipv4 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv4Config" }, "mtu": { "type": "integer", "description": "Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: MTU is not in the valid range., min = 0L) " }, "mac_address": { "type": "string", "description": "Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) " }, "site_wan_interface_ids": { "type": "array", "description": "Site Wan Interface Ids", "items": { "type": "string", "description": "Site Wan Interface Ids" } }, "attached_lan_networks": { "type": "array", "description": "Attached Lan Networks: Valid ", "items": { "$ref": "#/components/schemas/LanNetworkVlanMapping" } }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[InterfaceType], error = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "scope", "used_for", "type" ] }, "CellularModuleQueryFilter": { "properties": { "element_id": { "type": "string", "description": "Element Id" }, "primary_sim": { "type": "integer", "description": "Primary Sim: NotNull(error = CELLULAR_MODULE_CONFIG_PRIMARY_SIM_REQD: Primary SIM attribute cannot be null.) " }, "gps_enable": { "type": "boolean", "description": "Gps Enable: NotNull(error = CELLULAR_MODULE_CONFIG_GPS_ENABLE_REQD: GPS enable attribute cannot be null.) " }, "radio_on": { "type": "boolean", "description": "Radio On: NotNull(error = CELLULAR_MODULE_CONFIG_RADIO_ON_REQD: Radio On attribute cannot be null.) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "primary_sim", "gps_enable", "radio_on", "name" ] }, "InterfaceV4N8": { "properties": { "service_link_config": { "description": "Service Link Config: Valid Valid ", "$ref": "#/components/schemas/ServiceLinkV3" }, "nat_pools": { "type": "array", "description": "Nat Pools: Valid ", "items": { "$ref": "#/components/schemas/NatPool" } }, "devicemgmt_policysetstack_id": { "type": "string", "description": "Devicemgmt Policysetstack Id: Digits(fraction = 0, integer = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) " }, "nat_zone_id": { "type": "string", "description": "Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "bypass_pair": { "description": "Bypass Pair", "$ref": "#/components/schemas/BypassPairV2" }, "network_context_id": { "type": "string", "description": "Network Context Id" }, "parent": { "type": "string", "description": "Parent" }, "pppoe_config": { "description": "Pppoe Config: Valid Valid ", "$ref": "#/components/schemas/PppoE" }, "sub_interface": { "description": "Sub Interface: Valid ", "$ref": "#/components/schemas/SubInterface" }, "bound_interfaces": { "type": "array", "description": "Bound Interfaces", "items": { "type": "string", "description": "Bound Interfaces" } }, "used_for": { "type": "string", "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) " }, "nat_port": { "type": "integer", "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" }, "nat_address": { "type": "string", "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) " }, "admin_up": { "type": "boolean", "description": "Admin Up" }, "ethernet_port": { "description": "Ethernet Port", "$ref": "#/components/schemas/EthernetPort" }, "dhcp_relay": { "description": "Dhcp Relay: Valid ", "$ref": "#/components/schemas/DHCPRelay" }, "ipv4_config": { "description": "Ipv4 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv4Config" }, "mtu": { "type": "integer", "description": "Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: MTU is not in the valid range., min = 0L) " }, "mac_address": { "type": "string", "description": "Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) " }, "site_wan_interface_ids": { "type": "array", "description": "Site Wan Interface Ids", "items": { "type": "string", "description": "Site Wan Interface Ids" } }, "attached_lan_networks": { "type": "array", "description": "Attached Lan Networks: Valid ", "items": { "$ref": "#/components/schemas/LanNetworkVlanMapping" } }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[InterfaceType], error = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "scope", "used_for", "type" ] }, "InterfaceV4N9": { "properties": { "directed_broadcast": { "type": "boolean", "description": "Directed Broadcast" }, "service_link_config": { "description": "Service Link Config: Valid Valid ", "$ref": "#/components/schemas/ServiceLinkV3" }, "nat_pools": { "type": "array", "description": "Nat Pools: Valid ", "items": { "$ref": "#/components/schemas/NatPool" } }, "devicemgmt_policysetstack_id": { "type": "string", "description": "Devicemgmt Policysetstack Id: Digits(fraction = 0, integer = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) " }, "nat_zone_id": { "type": "string", "description": "Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "bypass_pair": { "description": "Bypass Pair", "$ref": "#/components/schemas/BypassPairV2" }, "network_context_id": { "type": "string", "description": "Network Context Id" }, "parent": { "type": "string", "description": "Parent" }, "pppoe_config": { "description": "Pppoe Config: Valid Valid ", "$ref": "#/components/schemas/PppoE" }, "sub_interface": { "description": "Sub Interface: Valid ", "$ref": "#/components/schemas/SubInterface" }, "bound_interfaces": { "type": "array", "description": "Bound Interfaces", "items": { "type": "string", "description": "Bound Interfaces" } }, "used_for": { "type": "string", "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) " }, "nat_port": { "type": "integer", "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" }, "nat_address": { "type": "string", "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) " }, "admin_up": { "type": "boolean", "description": "Admin Up" }, "ethernet_port": { "description": "Ethernet Port", "$ref": "#/components/schemas/EthernetPort" }, "dhcp_relay": { "description": "Dhcp Relay: Valid ", "$ref": "#/components/schemas/DHCPRelay" }, "ipv4_config": { "description": "Ipv4 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv4Config" }, "mtu": { "type": "integer", "description": "Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: MTU is not in the valid range., min = 0L) " }, "mac_address": { "type": "string", "description": "Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) " }, "site_wan_interface_ids": { "type": "array", "description": "Site Wan Interface Ids", "items": { "type": "string", "description": "Site Wan Interface Ids" } }, "attached_lan_networks": { "type": "array", "description": "Attached Lan Networks: Valid ", "items": { "$ref": "#/components/schemas/LanNetworkVlanMapping" } }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[InterfaceType], error = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "scope", "used_for", "type" ] }, "DHCPServerScreenV2N3": { "properties": { "vrf_context_id": { "type": "string", "description": "Vrf Context Id: Digits(fraction = 0, integer = 20, error = VRF_CONTEXT_ID_INVALID: VRF Context ID is empty or invalid.) " }, "static_mappings": { "type": "array", "description": "Static Mappings: Valid ", "items": { "$ref": "#/components/schemas/StaticMappingV2" } }, "address_family": { "type": "string", "description": "Address Family: ValidateEnum(enumClass = classOf[IPAddressFamily], DHCP_CONFIG_ADDRESS_FAMILY_INVALID, nullAllowed = false) ", "enum": [ "IPV4", "IPV6" ] }, "custom_options": { "type": "array", "description": "Custom Options: Valid ", "items": { "$ref": "#/components/schemas/CustomDHCPOptions" } }, "ip_ranges": { "type": "array", "description": "Ip Ranges: NotNull(error = DHCPSERVER_CONFIG_IP_RANGE_MISSING: Provide valid IPv4/IPv6 address range for defined subnet.) Size(max = 2147483647, error = DHCPSERVER_CONFIG_IP_RANGE_MISSING: Provide valid IPv4/IPv6 address range for defined subnet., min = 1) Valid ", "items": { "$ref": "#/components/schemas/IPRange" } }, "max_lease_time": { "type": "integer", "description": "Max Lease Time: Min(error = DHCPSERVER_CONFIG_UNSUPPORTED_MAX_LEASE_TIME: Max lease time should be between 300 and 2^32-1 seconds respectively., value = 300L) Max(error = DHCPSERVER_CONFIG_UNSUPPORTED_MAX_LEASE_TIME: Max lease time should be between 300 and 2^32-1 seconds respectively., value = 4294967295L) ", "format": "int64" }, "default_lease_time": { "type": "integer", "description": "Default Lease Time: Min(error = DHCPSERVER_CONFIG_UNSUPPORTED_DEFAULT_LEASE_TIME: Default lease time should be between 300 and 2^32-1 seconds respectively., value = 300L) Max(error = DHCPSERVER_CONFIG_UNSUPPORTED_DEFAULT_LEASE_TIME: Default lease time should be between 300 and 2^32-1 seconds respectively., value = 4294967295L) ", "format": "int64" }, "dns_servers": { "type": "array", "description": "Dns Servers: Size(max = 3, error = DHCPSERVER_CONFIG_DNS_ENTRIES_EXCEEDS_LIMIT: Name servers count exceeds the maximum limit, min = 0) ", "items": { "type": "string", "description": "Dns Servers" } }, "domain_name": { "type": "string", "description": "Domain Name: Size(max = 256, error = DHCPSERVER_CONFIG_INVALID_DOMAIN_NAME: Domain name exceeds the maximum limit., min = 0) " }, "broadcast_address": { "type": "string", "description": "Broadcast Address" }, "gateway": { "type": "string", "description": "Gateway" }, "subnet": { "type": "string", "description": "Subnet: NotNull(error = DHCPSERVER_CONFIG_INVALID_SUBNET_ADDR: Invalid IPv4 subnet address.) " }, "network_context_id": { "type": "string", "description": "Network Context Id: Digits(fraction = 0, integer = 50, error = INVALID_NETWORK_CTX_ID: Invalid network ctrx id.) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DHCPSERVER_CONFIG_DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds the maximum limit., min = 0) " }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 128, listMaxSize = 10, error = DHCPSERVER_CONFIG_INVALID_TAGS: Tags config is invalid- maximum 10 tags are supported, tag should not exceed maximum limit of 128 characters, it should not have duplicates., noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "disabled": { "type": "boolean", "description": "Disabled" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "address_family", "ip_ranges", "subnet" ] }, "InterfaceScreenV4N17": { "properties": { "vrf_context_id": { "type": "string", "description": "Vrf Context Id" }, "authentication_config": { "description": "Authentication Config", "$ref": "#/components/schemas/AuthenticationInterfaceConfig" }, "peer_bypasspair_wan_port_type": { "type": "string", "description": "Peer Bypasspair Wan Port Type", "enum": [ "none", "cellular" ] }, "ipv6_config": { "description": "Ipv6 Config: Valid ", "$ref": "#/components/schemas/Ipv6ConfigV1" }, "cellular_config": { "description": "Cellular Config", "$ref": "#/components/schemas/CellularInterfaceConfig" }, "pppoe_config": { "description": "Pppoe Config: Valid ", "$ref": "#/components/schemas/PppoEInterfaceConfig" }, "vlan_config": { "description": "Vlan Config", "$ref": "#/components/schemas/VlanConfig" }, "interface_profile_id": { "type": "string", "description": "Interface Profile Id" }, "switch_port_config": { "description": "Switch Port Config", "$ref": "#/components/schemas/SwitchPortConfig" }, "lldp_enabled": { "type": "boolean", "description": "Lldp Enabled" }, "power_usage_threshold": { "type": "integer", "description": "Power Usage Threshold", "format": "int32" }, "poe_enabled": { "type": "boolean", "description": "Poe Enabled" }, "multicast_config": { "description": "Multicast Config", "$ref": "#/components/schemas/MulticastInterfaceConfig" }, "nat_port_v6": { "type": "integer", "description": "Nat Port V6", "format": "int32" }, "nat_address_v6": { "type": "string", "description": "Nat Address V6" }, "static_arp_configs": { "type": "array", "description": "Static Arp Configs: Valid ", "items": { "$ref": "#/components/schemas/StaticARPConfig" } }, "secondary_ip_configs": { "type": "array", "description": "Secondary Ip Configs", "items": { "$ref": "#/components/schemas/SecondaryIPConfig" } }, "ipfixfiltercontext_id": { "type": "string", "description": "Ipfixfiltercontext Id" }, "ipfixcollectorcontext_id": { "type": "string", "description": "Ipfixcollectorcontext Id" }, "directed_broadcast": { "type": "boolean", "description": "Directed Broadcast" }, "service_link_config": { "description": "Service Link Config: Valid ", "$ref": "#/components/schemas/ServiceLinkV3" }, "nat_pools": { "type": "array", "description": "Nat Pools", "items": { "$ref": "#/components/schemas/NatPool" } }, "devicemgmt_policysetstack_id": { "type": "string", "description": "Devicemgmt Policysetstack Id" }, "nat_zone_id": { "type": "string", "description": "Nat Zone Id" }, "tags": { "type": "array", "description": "Tags", "items": { "type": "string", "description": "Tags" } }, "scope": { "type": "string", "description": "Scope", "enum": [ "GLOBAL", "LOCAL" ] }, "bypass_pair": { "description": "Bypass Pair", "$ref": "#/components/schemas/BypassPairV2" }, "network_context_id": { "type": "string", "description": "Network Context Id" }, "parent": { "type": "string", "description": "Parent" }, "sub_interface": { "description": "Sub Interface", "$ref": "#/components/schemas/SubInterface" }, "bound_interfaces": { "type": "array", "description": "Bound Interfaces", "items": { "type": "string", "description": "Bound Interfaces" } }, "used_for": { "type": "string", "description": "Used For" }, "nat_port": { "type": "integer", "description": "Nat Port", "format": "int32" }, "nat_address": { "type": "string", "description": "Nat Address" }, "admin_up": { "type": "boolean", "description": "Admin Up" }, "ethernet_port": { "description": "Ethernet Port", "$ref": "#/components/schemas/EthernetPort" }, "dhcp_relay": { "description": "Dhcp Relay: Valid ", "$ref": "#/components/schemas/DHCPRelay" }, "ipv4_config": { "description": "Ipv4 Config: Valid ", "$ref": "#/components/schemas/Ipv4Config" }, "mtu": { "type": "integer", "description": "Mtu" }, "mac_address": { "type": "string", "description": "Mac Address" }, "site_wan_interface_ids": { "type": "array", "description": "Site Wan Interface Ids", "items": { "type": "string", "description": "Site Wan Interface Ids" } }, "attached_lan_networks": { "type": "array", "description": "Attached Lan Networks: Valid ", "items": { "$ref": "#/components/schemas/LanNetworkVlanMapping" } }, "type": { "type": "string", "description": "Type" }, "description": { "type": "string", "description": "Description" }, "name": { "type": "string", "description": "Name" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "DHCPServerScreenV2N1": { "properties": { "custom_options": { "type": "array", "description": "Custom Options: Valid ", "items": { "$ref": "#/components/schemas/CustomDHCPOptions" } }, "static_mappings": { "type": "array", "description": "Static Mappings: Valid ", "items": { "$ref": "#/components/schemas/StaticMapping" } }, "ip_ranges": { "type": "array", "description": "Ip Ranges: NotNull(error = DHCPSERVER_CONFIG_IP_RANGE_MISSING: Provide valid IPv4/IPv6 address range for defined subnet.) Size(max = 2147483647, error = DHCPSERVER_CONFIG_IP_RANGE_MISSING: Provide valid IPv4/IPv6 address range for defined subnet., min = 1) Valid ", "items": { "$ref": "#/components/schemas/IPRange" } }, "max_lease_time": { "type": "integer", "description": "Max Lease Time: Min(error = DHCPSERVER_CONFIG_UNSUPPORTED_MAX_LEASE_TIME: Max lease time should be between 300 and 2^32-1 seconds respectively., value = 300L) Max(error = DHCPSERVER_CONFIG_UNSUPPORTED_MAX_LEASE_TIME: Max lease time should be between 300 and 2^32-1 seconds respectively., value = 4294967295L) ", "format": "int64" }, "default_lease_time": { "type": "integer", "description": "Default Lease Time: Min(error = DHCPSERVER_CONFIG_UNSUPPORTED_DEFAULT_LEASE_TIME: Default lease time should be between 300 and 2^32-1 seconds respectively., value = 300L) Max(error = DHCPSERVER_CONFIG_UNSUPPORTED_DEFAULT_LEASE_TIME: Default lease time should be between 300 and 2^32-1 seconds respectively., value = 4294967295L) ", "format": "int64" }, "dns_servers": { "type": "array", "description": "Dns Servers: Size(max = 3, error = DHCPSERVER_CONFIG_DNS_ENTRIES_EXCEEDS_LIMIT: Name servers count exceeds the maximum limit, min = 0) ", "items": { "type": "string", "description": "Dns Servers" } }, "domain_name": { "type": "string", "description": "Domain Name: Size(max = 256, error = DHCPSERVER_CONFIG_INVALID_DOMAIN_NAME: Domain name exceeds the maximum limit., min = 0) " }, "broadcast_address": { "type": "string", "description": "Broadcast Address" }, "gateway": { "type": "string", "description": "Gateway" }, "subnet": { "type": "string", "description": "Subnet: NotNull(error = DHCPSERVER_CONFIG_INVALID_SUBNET_ADDR: Invalid IPv4 subnet address.) " }, "network_context_id": { "type": "string", "description": "Network Context Id: Digits(fraction = 0, integer = 50, error = INVALID_NETWORK_CTX_ID: Invalid network ctrx id.) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DHCPSERVER_CONFIG_DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds the maximum limit., min = 0) " }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 128, listMaxSize = 10, error = DHCPSERVER_CONFIG_INVALID_TAGS: Tags config is invalid- maximum 10 tags are supported, tag should not exceed maximum limit of 128 characters, it should not have duplicates., noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "disabled": { "type": "boolean", "description": "Disabled" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "ip_ranges", "subnet" ] }, "EventCorrelationPolicyRule": { "properties": { "escalation_rules": { "description": "Escalation Rules: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) Valid ", "$ref": "#/components/schemas/EscalationRule" }, "enabled": { "type": "boolean", "description": "Enabled" }, "priority": { "type": "string", "description": "Priority: ValidateEnum(enumClass = classOf[EventPriority], error = EVENT_POLICY_INVALID_PRIORITY: Invalid priority is specified for event policy, nullAllowed = false) ", "enum": [ "p1", "p2", "p3", "p4", "p5", "none" ] }, "suppress": { "type": "string", "description": "Suppress: ValidateEnum(enumClass = classOf[Suppress], error = EVENT_POLICY_INVALID_SUPPRESS: Invalid suppress value is specified for event policy, nullAllowed = false) ", "enum": [ "yes", "no", "none" ] }, "event_codes": { "type": "array", "description": "Event Codes", "items": { "type": "string", "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", "DEVICE_CELLULAR_MODEM_GPS_DC_BIOS_FAULT", "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", "CUID_SYNC_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", "DEVICESW_MFGCERT_RENEWAL_FAILED", "DEVICESW_MFGCERT_EXPIRY_WARNING", "DEVICEHW_POWER_MISSING", "SYSTEM_CIRCUIT_UTILIZATION_THRESHOLD_EXCEEDED", "SYSTEM_CPU_THRESHOLD_EXCEEDED", "SYSTEM_MEMORY_THRESHOLD_EXCEEDED", "SYSTEM_DISK_THRESHOLD_EXCEEDED", "SYSTEM_CONCURRENT_FLOW_THRESHOLD_EXCEEDED", "DEVICESW_MCTD_INITIALIZATION_FAILURE", "DEVICESW_MCTD_CONTENT_LOAD_FAILURE", "DEVICESW_MCTD_LOG_BUFFER_FULL", "DEVICESW_URLCLOUDSERVER_DOWN", "DEVICESW_DNSSECCLOUDSERVER_DOWN", "DEVICESW_SLSCONNECTION_DOWN", "ALL_INCIDENTS", "ALL_ALERTS", "DEVICESW_TACACS_SERVERS_DOWN", "BRANCH_GATEWAY_CLUSTER_SITE_COUNT_THRESHOLD_EXCEEDED", "FLOW_LIMIT_PER_SOURCE_EXCEEDED", "SECURITY_POLICY_RULES_FAILED", "NPNSPN_INSUFFICIENT_VALID_GENEVE_KEYS", "INCONSISTENT_IPSEC_TUNNEL_HA_STATE", "NPN_MP_CPU_HIGH" ] } }, "end_time": { "type": "integer", "description": "End Time", "format": "int64" }, "start_time": { "type": "integer", "description": "Start Time", "format": "int64" }, "resource_ids": { "type": "array", "description": "Resource Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, error = EVENT_POLICY_INVALID_RESOURCES: Invalid resource(s) is specified for event policy, noTrim = false, regex = [0-9]{1,30}, required = false) Size(max = 2000, error = EVENT_POLICY_RULE_MAX_RESOURCE_IDS: Maximum 128 resources can be configured in a rule, min = 0) ", "items": { "type": "string", "description": "Resource Ids" } }, "sub_resource_type": { "type": "string", "description": "Sub Resource Type: ValidateEnum(enumClass = classOf[SubResourceType], error = EVENT_POLICY_INVALID_RESOURCE_SUB_TYPE: Invalid sub resource type is specified for event policy, nullAllowed = true) ", "enum": [ "spoke", "hub", "public", "private" ] }, "resource_type": { "type": "string", "description": "Resource Type: ValidateEnum(enumClass = classOf[ResourceType], error = EVENT_POLICY_INVALID_RESOURCE_TYPE: Invalid resource type is specified for event policy, nullAllowed = true) ", "enum": [ "site", "element", "anynetlink", "bgppeer", "interface", "waninterface", "wannetwork", "networkpolicyset", "prioritypolicyset", "natpolicyset", "securitypolicyset", "appdef", "serviceendpoint", "cellular_module", "hubcluster", "useridagent", "directoryservice", "cuid", "deviceidconfig", "machine", "spokecluster", "user_id" ] }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "priority", "suppress", "name" ] }, "Licenses": { "properties": { "scm_pro": { "description": "Scm Pro", "$ref": "#/components/schemas/LicenseCategory" }, "sdwan": { "description": "Sdwan", "$ref": "#/components/schemas/LicenseCategory" }, "strata_logging_service": { "description": "Strata Logging Service", "$ref": "#/components/schemas/LicenseCategory" }, "iot_security": { "description": "Iot Security", "$ref": "#/components/schemas/LicenseCategory" }, "security_services": { "description": "Security Services", "$ref": "#/components/schemas/LicenseCategory" } } }, "DHCPServerScreenV2N2": { "properties": { "static_mappings": { "type": "array", "description": "Static Mappings: Valid ", "items": { "$ref": "#/components/schemas/StaticMappingV2" } }, "address_family": { "type": "string", "description": "Address Family: ValidateEnum(enumClass = classOf[IPAddressFamily], DHCP_CONFIG_ADDRESS_FAMILY_INVALID, nullAllowed = false) ", "enum": [ "IPV4", "IPV6" ] }, "custom_options": { "type": "array", "description": "Custom Options: Valid ", "items": { "$ref": "#/components/schemas/CustomDHCPOptions" } }, "ip_ranges": { "type": "array", "description": "Ip Ranges: NotNull(error = DHCPSERVER_CONFIG_IP_RANGE_MISSING: Provide valid IPv4/IPv6 address range for defined subnet.) Size(max = 2147483647, error = DHCPSERVER_CONFIG_IP_RANGE_MISSING: Provide valid IPv4/IPv6 address range for defined subnet., min = 1) Valid ", "items": { "$ref": "#/components/schemas/IPRange" } }, "max_lease_time": { "type": "integer", "description": "Max Lease Time: Min(error = DHCPSERVER_CONFIG_UNSUPPORTED_MAX_LEASE_TIME: Max lease time should be between 300 and 2^32-1 seconds respectively., value = 300L) Max(error = DHCPSERVER_CONFIG_UNSUPPORTED_MAX_LEASE_TIME: Max lease time should be between 300 and 2^32-1 seconds respectively., value = 4294967295L) ", "format": "int64" }, "default_lease_time": { "type": "integer", "description": "Default Lease Time: Min(error = DHCPSERVER_CONFIG_UNSUPPORTED_DEFAULT_LEASE_TIME: Default lease time should be between 300 and 2^32-1 seconds respectively., value = 300L) Max(error = DHCPSERVER_CONFIG_UNSUPPORTED_DEFAULT_LEASE_TIME: Default lease time should be between 300 and 2^32-1 seconds respectively., value = 4294967295L) ", "format": "int64" }, "dns_servers": { "type": "array", "description": "Dns Servers: Size(max = 3, error = DHCPSERVER_CONFIG_DNS_ENTRIES_EXCEEDS_LIMIT: Name servers count exceeds the maximum limit, min = 0) ", "items": { "type": "string", "description": "Dns Servers" } }, "domain_name": { "type": "string", "description": "Domain Name: Size(max = 256, error = DHCPSERVER_CONFIG_INVALID_DOMAIN_NAME: Domain name exceeds the maximum limit., min = 0) " }, "broadcast_address": { "type": "string", "description": "Broadcast Address" }, "gateway": { "type": "string", "description": "Gateway" }, "subnet": { "type": "string", "description": "Subnet: NotNull(error = DHCPSERVER_CONFIG_INVALID_SUBNET_ADDR: Invalid IPv4 subnet address.) " }, "network_context_id": { "type": "string", "description": "Network Context Id: Digits(fraction = 0, integer = 50, error = INVALID_NETWORK_CTX_ID: Invalid network ctrx id.) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DHCPSERVER_CONFIG_DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds the maximum limit., min = 0) " }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 128, listMaxSize = 10, error = DHCPSERVER_CONFIG_INVALID_TAGS: Tags config is invalid- maximum 10 tags are supported, tag should not exceed maximum limit of 128 characters, it should not have duplicates., noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "disabled": { "type": "boolean", "description": "Disabled" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "address_family", "ip_ranges", "subnet" ] }, "InterfaceScreenV4N18": { "properties": { "service_link_config": { "description": "Service Link Config: Valid ", "$ref": "#/components/schemas/ServiceLinkV4" }, "vlan_config": { "description": "Vlan Config: Valid ", "$ref": "#/components/schemas/VlanConfig" }, "vrf_context_id": { "type": "string", "description": "Vrf Context Id: Digits(fraction = 0, integer = 20, error = VRF_CONTEXT_ID_INVALID: VRF Context ID is empty or invalid.) " }, "authentication_config": { "description": "Authentication Config: Valid ", "$ref": "#/components/schemas/AuthenticationInterfaceConfig" }, "peer_bypasspair_wan_port_type": { "type": "string", "description": "Peer Bypasspair Wan Port Type: ValidateEnum(enumClass = classOf[PortExtensionType], message = Invalid enum string., nullAllowed = false) ", "enum": [ "none", "cellular" ] }, "ipv6_config": { "description": "Ipv6 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv6ConfigV1" }, "cellular_config": { "description": "Cellular Config: Valid ", "$ref": "#/components/schemas/CellularInterfaceConfig" }, "pppoe_config": { "description": "Pppoe Config: Valid Valid ", "$ref": "#/components/schemas/PppoEInterfaceConfig" }, "interface_profile_id": { "type": "string", "description": "Interface Profile Id" }, "switch_port_config": { "description": "Switch Port Config: Valid ", "$ref": "#/components/schemas/SwitchPortConfig" }, "lldp_enabled": { "type": "boolean", "description": "Lldp Enabled" }, "power_usage_threshold": { "type": "integer", "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" }, "poe_enabled": { "type": "boolean", "description": "Poe Enabled" }, "multicast_config": { "description": "Multicast Config: Valid ", "$ref": "#/components/schemas/MulticastInterfaceConfig" }, "nat_port_v6": { "type": "integer", "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" }, "nat_address_v6": { "type": "string", "description": "Nat Address V6: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, error = INVALID_IPV6_NAT: IPv6 NAT address is invalid., type = IPV6) " }, "static_arp_configs": { "type": "array", "description": "Static Arp Configs: Valid Valid 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" } }, "secondary_ip_configs": { "type": "array", "description": "Secondary Ip Configs", "items": { "$ref": "#/components/schemas/SecondaryIPConfig" } }, "ipfixfiltercontext_id": { "type": "string", "description": "Ipfixfiltercontext Id" }, "ipfixcollectorcontext_id": { "type": "string", "description": "Ipfixcollectorcontext Id" }, "directed_broadcast": { "type": "boolean", "description": "Directed Broadcast" }, "nat_pools": { "type": "array", "description": "Nat Pools: Valid ", "items": { "$ref": "#/components/schemas/NatPool" } }, "devicemgmt_policysetstack_id": { "type": "string", "description": "Devicemgmt Policysetstack Id: Digits(fraction = 0, integer = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) " }, "nat_zone_id": { "type": "string", "description": "Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "bypass_pair": { "description": "Bypass Pair", "$ref": "#/components/schemas/BypassPairV2" }, "network_context_id": { "type": "string", "description": "Network Context Id" }, "parent": { "type": "string", "description": "Parent" }, "sub_interface": { "description": "Sub Interface: Valid ", "$ref": "#/components/schemas/SubInterface" }, "bound_interfaces": { "type": "array", "description": "Bound Interfaces", "items": { "type": "string", "description": "Bound Interfaces" } }, "used_for": { "type": "string", "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) " }, "nat_port": { "type": "integer", "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" }, "nat_address": { "type": "string", "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) " }, "admin_up": { "type": "boolean", "description": "Admin Up" }, "ethernet_port": { "description": "Ethernet Port", "$ref": "#/components/schemas/EthernetPort" }, "dhcp_relay": { "description": "Dhcp Relay: Valid ", "$ref": "#/components/schemas/DHCPRelay" }, "ipv4_config": { "description": "Ipv4 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv4Config" }, "mtu": { "type": "integer", "description": "Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: MTU is not in the valid range., min = 0L) " }, "mac_address": { "type": "string", "description": "Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) " }, "site_wan_interface_ids": { "type": "array", "description": "Site Wan Interface Ids", "items": { "type": "string", "description": "Site Wan Interface Ids" } }, "attached_lan_networks": { "type": "array", "description": "Attached Lan Networks: Valid ", "items": { "$ref": "#/components/schemas/LanNetworkVlanMapping" } }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[InterfaceType], error = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "peer_bypasspair_wan_port_type", "scope", "used_for", "type" ] }, "InterfaceScreenV4N19": { "properties": { "port_channel_config": { "description": "Port Channel Config: Valid ", "$ref": "#/components/schemas/PortChannelConfig" }, "service_link_config": { "description": "Service Link Config: Valid ", "$ref": "#/components/schemas/ServiceLinkV4" }, "vlan_config": { "description": "Vlan Config: Valid ", "$ref": "#/components/schemas/VlanConfig" }, "vrf_context_id": { "type": "string", "description": "Vrf Context Id: Digits(fraction = 0, integer = 20, error = VRF_CONTEXT_ID_INVALID: VRF Context ID is empty or invalid.) " }, "authentication_config": { "description": "Authentication Config: Valid ", "$ref": "#/components/schemas/AuthenticationInterfaceConfig" }, "peer_bypasspair_wan_port_type": { "type": "string", "description": "Peer Bypasspair Wan Port Type: ValidateEnum(enumClass = classOf[PortExtensionType], message = Invalid enum string., nullAllowed = false) ", "enum": [ "none", "cellular" ] }, "ipv6_config": { "description": "Ipv6 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv6ConfigV1" }, "cellular_config": { "description": "Cellular Config: Valid ", "$ref": "#/components/schemas/CellularInterfaceConfig" }, "pppoe_config": { "description": "Pppoe Config: Valid Valid ", "$ref": "#/components/schemas/PppoEInterfaceConfig" }, "interface_profile_id": { "type": "string", "description": "Interface Profile Id" }, "switch_port_config": { "description": "Switch Port Config: Valid ", "$ref": "#/components/schemas/SwitchPortConfig" }, "lldp_enabled": { "type": "boolean", "description": "Lldp Enabled" }, "power_usage_threshold": { "type": "integer", "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" }, "poe_enabled": { "type": "boolean", "description": "Poe Enabled" }, "multicast_config": { "description": "Multicast Config: Valid ", "$ref": "#/components/schemas/MulticastInterfaceConfig" }, "nat_port_v6": { "type": "integer", "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" }, "nat_address_v6": { "type": "string", "description": "Nat Address V6: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, error = INVALID_IPV6_NAT: IPv6 NAT address is invalid., type = IPV6) " }, "static_arp_configs": { "type": "array", "description": "Static Arp Configs: Valid Valid 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" } }, "secondary_ip_configs": { "type": "array", "description": "Secondary Ip Configs", "items": { "$ref": "#/components/schemas/SecondaryIPConfig" } }, "ipfixfiltercontext_id": { "type": "string", "description": "Ipfixfiltercontext Id" }, "ipfixcollectorcontext_id": { "type": "string", "description": "Ipfixcollectorcontext Id" }, "directed_broadcast": { "type": "boolean", "description": "Directed Broadcast" }, "nat_pools": { "type": "array", "description": "Nat Pools: Valid ", "items": { "$ref": "#/components/schemas/NatPool" } }, "devicemgmt_policysetstack_id": { "type": "string", "description": "Devicemgmt Policysetstack Id: Digits(fraction = 0, integer = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) " }, "nat_zone_id": { "type": "string", "description": "Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "bypass_pair": { "description": "Bypass Pair", "$ref": "#/components/schemas/BypassPairV2" }, "network_context_id": { "type": "string", "description": "Network Context Id" }, "parent": { "type": "string", "description": "Parent" }, "sub_interface": { "description": "Sub Interface: Valid ", "$ref": "#/components/schemas/SubInterface" }, "bound_interfaces": { "type": "array", "description": "Bound Interfaces", "items": { "type": "string", "description": "Bound Interfaces" } }, "used_for": { "type": "string", "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) " }, "nat_port": { "type": "integer", "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" }, "nat_address": { "type": "string", "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) " }, "admin_up": { "type": "boolean", "description": "Admin Up" }, "ethernet_port": { "description": "Ethernet Port", "$ref": "#/components/schemas/EthernetPort" }, "dhcp_relay": { "description": "Dhcp Relay: Valid ", "$ref": "#/components/schemas/DHCPRelay" }, "ipv4_config": { "description": "Ipv4 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv4Config" }, "mtu": { "type": "integer", "description": "Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: MTU is not in the valid range., min = 0L) " }, "mac_address": { "type": "string", "description": "Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) " }, "site_wan_interface_ids": { "type": "array", "description": "Site Wan Interface Ids", "items": { "type": "string", "description": "Site Wan Interface Ids" } }, "attached_lan_networks": { "type": "array", "description": "Attached Lan Networks: Valid ", "items": { "$ref": "#/components/schemas/LanNetworkVlanMapping" } }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[InterfaceType], error = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "peer_bypasspair_wan_port_type", "scope", "used_for", "type" ] }, "SecurityPolicyV2LocalPrefixScreen": { "properties": { "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "BandwidthRange": { "properties": { "high": { "type": "number", "description": "High", "format": "double" }, "low": { "type": "number", "description": "Low", "format": "double" } } }, "SoftwareDownloadHistoryQuery": { "properties": { "isReadPreferenceSecondary": { "type": "boolean", "description": "IsReadPreferenceSecondary: JsonIgnore(value = true) " }, "last_query_ts": { "type": "integer", "description": "Last Query Ts", "format": "int64" }, "getDeleted": { "type": "boolean", "description": "GetDeleted" }, "aggregate": { "description": "Aggregate", "$ref": "#/components/schemas/Aggregate" }, "group_by": { "type": "array", "description": "Group By", "items": { "type": "string", "description": "Group By" } }, "retrieved_fields": { "type": "array", "description": "Retrieved Fields", "items": { "type": "string", "description": "Retrieved Fields" } }, "retrieved_fields_mask": { "type": "boolean", "description": "Retrieved Fields Mask" }, "total_count": { "type": "integer", "description": "Total Count", "format": "int64" }, "dest_page": { "type": "integer", "description": "Dest Page", "format": "int32" }, "next_query": { "type": "object" }, "limit": { "type": "integer", "description": "Limit", "format": "int32" }, "sort_case_insensitive": { "type": "boolean", "description": "Sort Case Insensitive" }, "sort_params": { "type": "object" }, "query_params": { "type": "object" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "SecurityPolicyGlobalPrefix": { "properties": { "ipv4_prefixes": { "type": "array", "description": "Ipv4 Prefixes: ListIPAddress(bcast = DENY, listMaxSize = 0, error = INVALID_PREFIX: Prefix is not valid OR not within the valid prefix range., required = false, type = PREFIXCIDR_ALL) ", "items": { "type": "string", "description": "Ipv4 Prefixes" } }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "ElementShellQuery": { "properties": { "isReadPreferenceSecondary": { "type": "boolean", "description": "IsReadPreferenceSecondary: JsonIgnore(value = true) " }, "last_query_ts": { "type": "integer", "description": "Last Query Ts", "format": "int64" }, "getDeleted": { "type": "boolean", "description": "GetDeleted" }, "aggregate": { "description": "Aggregate", "$ref": "#/components/schemas/Aggregate" }, "group_by": { "type": "array", "description": "Group By", "items": { "type": "string", "description": "Group By" } }, "retrieved_fields": { "type": "array", "description": "Retrieved Fields", "items": { "type": "string", "description": "Retrieved Fields" } }, "retrieved_fields_mask": { "type": "boolean", "description": "Retrieved Fields Mask" }, "total_count": { "type": "integer", "description": "Total Count", "format": "int64" }, "dest_page": { "type": "integer", "description": "Dest Page", "format": "int32" }, "next_query": { "type": "object" }, "limit": { "type": "integer", "description": "Limit", "format": "int32" }, "sort_case_insensitive": { "type": "boolean", "description": "Sort Case Insensitive" }, "sort_params": { "type": "object" }, "query_params": { "type": "object" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "VRFContextQueryFilter": { "properties": { "default_vrf_context": { "type": "boolean", "description": "Default Vrf Context" }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = VRF_CONTEXT_CONFIG_DESCRIPTION_INVALID: Vrf context config description invalid., min = 0) " }, "name": { "type": "string", "description": "Name: NotBlank(error = VRF_CONTEXT_NAME_INVALID: Vrf context config name required) Size(max = 128, error = VRF_CONTEXT_NAME_EXCEEDS_LIMIT: Vrf Context Name exceeds limit, min = 0) Pattern(error = VRF_CONTEXT_NAME_INVALID: Vrf context config name required, regexp = ^[A-Za-z][A-Za-z0-9_\\\\s-]*$) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "ElementNTPV2N1": { "properties": { "source_interface_ids": { "type": "array", "description": "Source Interface Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 10, error = NTP_CONFIG_INVALID_INTERFACE_IDS: Source interface ids cannot be empty and should be valid.Interface ids should not be port that is part of logical interface group like bypass pair., noTrim = false, regex = , required = false) ", "items": { "type": "string", "description": "Source Interface Ids" } }, "ntp_servers": { "type": "array", "description": "Ntp Servers: NotEmpty(error = NTP_CONFIG_INVALID_SERVER_SIZE: A minimum of 1 and a maximum of 10 NTP servers can be configured.) Size(max = 10, error = NTP_CONFIG_INVALID_SERVER_SIZE: A minimum of 1 and a maximum of 10 NTP servers can be configured., min = 1) Valid ", "items": { "$ref": "#/components/schemas/NTPServer" } }, "tags": { "type": "array", "description": "Tags", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = NTP_CONFIG_DESCRIPTION_INVALID: NTP description is invalid. The maximum length is 256., min = 0) " }, "name": { "type": "string", "description": "Name: NotEmpty(error = NTP_CONFIG_NAME_REQD: Name is mandatory for NTP configuration.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "ntp_servers", "name" ] }, "SecurityZoneV2N2": { "properties": { "is_l2": { "type": "boolean", "description": "Is L2" }, "tcp_allow_non_syn": { "type": "boolean", "description": "Tcp Allow Non Syn" }, "description": { "type": "string", "description": "Description: Size(max = 256, error = SECURITYZONE_DESCRIPTION_INVALID: Security zone description exceeds limit., min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = SECURITYZONE_NAME_INVALID: Security zone name exceeds limit., min = 0) Required(error = SECURITYZONE_NAME_REQUIRED: Security zone name required.) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "StaticRouteStatusV2N2": { "properties": { "nexthops": { "type": "array", "description": "Nexthops: Valid ", "items": { "$ref": "#/components/schemas/StateNextHop" } }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "SecurityZoneV2N1": { "properties": { "tcp_allow_non_syn": { "type": "boolean", "description": "Tcp Allow Non Syn" }, "description": { "type": "string", "description": "Description: Size(max = 256, error = SECURITYZONE_DESCRIPTION_INVALID: Security zone description exceeds limit., min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = SECURITYZONE_NAME_INVALID: Security zone name exceeds limit., min = 0) Required(error = SECURITYZONE_NAME_REQUIRED: Security zone name required.) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "GPSState": { "properties": { "longitude": { "type": "number", "description": "Longitude", "format": "double" }, "latitude": { "type": "number", "description": "Latitude", "format": "double" }, "state": { "type": "string", "description": "State" } } }, "SiteV4N13": { "properties": { "element_system_limit_profile_id": { "type": "string", "description": "Element System Limit Profile Id" }, "sgi_config": { "description": "Sgi Config: Valid ", "$ref": "#/components/schemas/SecurityGroupInformationConfig" }, "app_acceleration_enabled": { "type": "boolean", "description": "App Acceleration Enabled" }, "prefer_lan_default_over_wan_default_route": { "type": "boolean", "description": "Prefer Lan Default Over Wan Default Route" }, "branch_gateway": { "type": "boolean", "description": "Branch Gateway" }, "perfmgmt_policysetstack_id": { "type": "string", "description": "Perfmgmt Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_PERFMGMT_POLICYSETSTACK_ID: Invalid performance management policy set stack id) " }, "vrf_context_profile_id": { "type": "string", "description": "Vrf Context Profile Id" }, "multicast_peer_group_id": { "type": "string", "description": "Multicast Peer Group Id" }, "security_policysetstack_id": { "type": "string", "description": "Security Policysetstack Id" }, "extended_tags": { "type": "array", "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" } }, "nat_policysetstack_id": { "type": "string", "description": "Nat Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) " }, "priority_policysetstack_id": { "type": "string", "description": "Priority Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy set stack id) " }, "network_policysetstack_id": { "type": "string", "description": "Network Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy set stack id) " }, "service_binding": { "type": "string", "description": "Service Binding" }, "security_policyset_id": { "type": "string", "description": "Security Policyset Id" }, "element_cluster_role": { "type": "string", "description": "Element Cluster Role: Required(error = SITE_ROLE_MISSING: Site role missing.) ValidateEnum(enumClass = classOf[ElementClusterRole], message = Invalid enum string., nullAllowed = false) " }, "policy_set_id": { "type": "string", "description": "Policy Set Id" }, "location": { "description": "Location: Valid ", "$ref": "#/components/schemas/Location" }, "address": { "description": "Address: Valid ", "$ref": "#/components/schemas/Address" }, "admin_state": { "type": "string", "description": "Admin State: Required(error = SITE_ADMIN_STATE_MISSING: Site admin state missing.) ValidateEnum(enumClass = classOf[SiteState], message = Invalid enum string., nullAllowed = false) " }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 1024, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "element_cluster_role", "admin_state", "name" ] }, "SiteV4N11": { "properties": { "app_acceleration_enabled": { "type": "boolean", "description": "App Acceleration Enabled" }, "prefer_lan_default_over_wan_default_route": { "type": "boolean", "description": "Prefer Lan Default Over Wan Default Route" }, "branch_gateway": { "type": "boolean", "description": "Branch Gateway" }, "perfmgmt_policysetstack_id": { "type": "string", "description": "Perfmgmt Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_PERFMGMT_POLICYSETSTACK_ID: Invalid performance management policy set stack id) " }, "vrf_context_profile_id": { "type": "string", "description": "Vrf Context Profile Id" }, "multicast_peer_group_id": { "type": "string", "description": "Multicast Peer Group Id" }, "security_policysetstack_id": { "type": "string", "description": "Security Policysetstack Id" }, "extended_tags": { "type": "array", "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" } }, "nat_policysetstack_id": { "type": "string", "description": "Nat Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) " }, "priority_policysetstack_id": { "type": "string", "description": "Priority Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy set stack id) " }, "network_policysetstack_id": { "type": "string", "description": "Network Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy set stack id) " }, "service_binding": { "type": "string", "description": "Service Binding" }, "security_policyset_id": { "type": "string", "description": "Security Policyset Id" }, "element_cluster_role": { "type": "string", "description": "Element Cluster Role: Required(error = SITE_ROLE_MISSING: Site role missing.) ValidateEnum(enumClass = classOf[ElementClusterRole], message = Invalid enum string., nullAllowed = false) " }, "policy_set_id": { "type": "string", "description": "Policy Set Id" }, "location": { "description": "Location: Valid ", "$ref": "#/components/schemas/Location" }, "address": { "description": "Address: Valid ", "$ref": "#/components/schemas/Address" }, "admin_state": { "type": "string", "description": "Admin State: Required(error = SITE_ADMIN_STATE_MISSING: Site admin state missing.) ValidateEnum(enumClass = classOf[SiteState], message = Invalid enum string., nullAllowed = false) " }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 1024, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "element_cluster_role", "admin_state", "name" ] }, "Subnet": { "properties": { "ipv6_prefix_length": { "type": "integer", "description": "Ipv6 Prefix Length: Required(message = DNSQUERYMETADATA_CONFIG_INVALID_IPV6_PREFIX_LENGTH_MISSING) Range(max = 128L, error = DNSQUERYMETADATA_CONFIG_INVALID_IPV6_PREFIX_LENGTH_RANGE: ipv6 prefix length is not in valid range '0-128', min = 0L) ", "format": "int32" }, "ipv6_address": { "type": "string", "description": "Ipv6 Address: IPv6(error = DNSQUERYMETADATA_CONFIG_INVALID_IPV6_ADDRESS: Invalid subnet ipv6 address, regexp = [/0-9a-zA-Z:.]*) " }, "ipv4_prefix_length": { "type": "integer", "description": "Ipv4 Prefix Length: Required(message = DNSQUERYMETADATA_CONFIG_INVALID_IP_PREFIX_LENGTH_MISSING) Range(max = 32L, error = DNSQUERYMETADATA_CONFIG_INVALID_IP_PREFIX_LENGTH_RANGE: ipv4 prefix length is not in valid range '0-32', min = 0L) ", "format": "int32" }, "ipv4_address": { "type": "string", "description": "Ipv4 Address: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, error = DNSQUERYMETADATA_CONFIG_INVALID_IP_ADDRESS: Invalid subnet ipv4 address, type = IP) " } }, "required": [ "ipv6_prefix_length", "ipv4_prefix_length" ] }, "SiteV4N12": { "properties": { "sgi_config": { "description": "Sgi Config: Valid ", "$ref": "#/components/schemas/SecurityGroupInformationConfig" }, "app_acceleration_enabled": { "type": "boolean", "description": "App Acceleration Enabled" }, "prefer_lan_default_over_wan_default_route": { "type": "boolean", "description": "Prefer Lan Default Over Wan Default Route" }, "branch_gateway": { "type": "boolean", "description": "Branch Gateway" }, "perfmgmt_policysetstack_id": { "type": "string", "description": "Perfmgmt Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_PERFMGMT_POLICYSETSTACK_ID: Invalid performance management policy set stack id) " }, "vrf_context_profile_id": { "type": "string", "description": "Vrf Context Profile Id" }, "multicast_peer_group_id": { "type": "string", "description": "Multicast Peer Group Id" }, "security_policysetstack_id": { "type": "string", "description": "Security Policysetstack Id" }, "extended_tags": { "type": "array", "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" } }, "nat_policysetstack_id": { "type": "string", "description": "Nat Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) " }, "priority_policysetstack_id": { "type": "string", "description": "Priority Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy set stack id) " }, "network_policysetstack_id": { "type": "string", "description": "Network Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy set stack id) " }, "service_binding": { "type": "string", "description": "Service Binding" }, "security_policyset_id": { "type": "string", "description": "Security Policyset Id" }, "element_cluster_role": { "type": "string", "description": "Element Cluster Role: Required(error = SITE_ROLE_MISSING: Site role missing.) ValidateEnum(enumClass = classOf[ElementClusterRole], message = Invalid enum string., nullAllowed = false) " }, "policy_set_id": { "type": "string", "description": "Policy Set Id" }, "location": { "description": "Location: Valid ", "$ref": "#/components/schemas/Location" }, "address": { "description": "Address: Valid ", "$ref": "#/components/schemas/Address" }, "admin_state": { "type": "string", "description": "Admin State: Required(error = SITE_ADMIN_STATE_MISSING: Site admin state missing.) ValidateEnum(enumClass = classOf[SiteState], message = Invalid enum string., nullAllowed = false) " }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 1024, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "element_cluster_role", "admin_state", "name" ] }, "SubInterface": { "properties": { "vlan_id": { "type": "integer", "description": "Vlan Id", "format": "int32" } } }, "SiteV4N10": { "properties": { "prefer_lan_default_over_wan_default_route": { "type": "boolean", "description": "Prefer Lan Default Over Wan Default Route" }, "branch_gateway": { "type": "boolean", "description": "Branch Gateway" }, "perfmgmt_policysetstack_id": { "type": "string", "description": "Perfmgmt Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_PERFMGMT_POLICYSETSTACK_ID: Invalid performance management policy set stack id) " }, "vrf_context_profile_id": { "type": "string", "description": "Vrf Context Profile Id" }, "multicast_peer_group_id": { "type": "string", "description": "Multicast Peer Group Id" }, "security_policysetstack_id": { "type": "string", "description": "Security Policysetstack Id" }, "extended_tags": { "type": "array", "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" } }, "nat_policysetstack_id": { "type": "string", "description": "Nat Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) " }, "priority_policysetstack_id": { "type": "string", "description": "Priority Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy set stack id) " }, "network_policysetstack_id": { "type": "string", "description": "Network Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy set stack id) " }, "service_binding": { "type": "string", "description": "Service Binding" }, "security_policyset_id": { "type": "string", "description": "Security Policyset Id" }, "element_cluster_role": { "type": "string", "description": "Element Cluster Role: Required(error = SITE_ROLE_MISSING: Site role missing.) ValidateEnum(enumClass = classOf[ElementClusterRole], message = Invalid enum string., nullAllowed = false) " }, "policy_set_id": { "type": "string", "description": "Policy Set Id" }, "location": { "description": "Location: Valid ", "$ref": "#/components/schemas/Location" }, "address": { "description": "Address: Valid ", "$ref": "#/components/schemas/Address" }, "admin_state": { "type": "string", "description": "Admin State: Required(error = SITE_ADMIN_STATE_MISSING: Site admin state missing.) ValidateEnum(enumClass = classOf[SiteState], message = Invalid enum string., nullAllowed = false) " }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 1024, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "element_cluster_role", "admin_state", "name" ] }, "OspfConfigQuery": { "properties": { "isReadPreferenceSecondary": { "type": "boolean", "description": "IsReadPreferenceSecondary: JsonIgnore(value = true) " }, "last_query_ts": { "type": "integer", "description": "Last Query Ts", "format": "int64" }, "getDeleted": { "type": "boolean", "description": "GetDeleted" }, "aggregate": { "description": "Aggregate", "$ref": "#/components/schemas/Aggregate" }, "group_by": { "type": "array", "description": "Group By", "items": { "type": "string", "description": "Group By" } }, "retrieved_fields": { "type": "array", "description": "Retrieved Fields", "items": { "type": "string", "description": "Retrieved Fields" } }, "retrieved_fields_mask": { "type": "boolean", "description": "Retrieved Fields Mask" }, "total_count": { "type": "integer", "description": "Total Count", "format": "int64" }, "dest_page": { "type": "integer", "description": "Dest Page", "format": "int32" }, "next_query": { "type": "object" }, "limit": { "type": "integer", "description": "Limit", "format": "int32" }, "sort_case_insensitive": { "type": "boolean", "description": "Sort Case Insensitive" }, "sort_params": { "type": "object" }, "query_params": { "type": "object" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "SnapshotImportScreen": { "properties": { "yaml_configuration": { "type": "string", "description": "Yaml Configuration" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "IPSECConfigV1": { "properties": { "authentication": { "description": "Authentication", "$ref": "#/components/schemas/IPSECAuthenticationV1" }, "ipsec_profile_id": { "type": "string", "description": "Ipsec Profile Id: Required(error = IPSEC_PROFILE_ID_MISSING: IPSEC Profile must be specified for IPSEC VPNs) " } }, "required": [ "ipsec_profile_id" ] }, "PathGroup": { "properties": { "paths": { "type": "array", "description": "Paths", "items": { "$ref": "#/components/schemas/WANPath" } }, "description": { "type": "string", "description": "Description" }, "name": { "type": "string", "description": "Name" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "DnsQueriesMetadata": { "properties": { "add_subnets": { "type": "array", "description": "Add Subnets: Valid Size(max = 2, error = DNS_SUBNET_MAXIMUM_LIMITED_EXCEEDED: Maximum 2 subnets are allowed in dns service configuration, min = 0) ", "items": { "$ref": "#/components/schemas/Subnet" } }, "add_customer_premises_equipment": { "description": "Add Customer Premises Equipment: Valid ", "$ref": "#/components/schemas/CustomerPremisesEquipment" }, "add_client_mac": { "description": "Add Client Mac: Valid ", "$ref": "#/components/schemas/ClientMac" } } }, "URLCategoryQuery": { "properties": { "isReadPreferenceSecondary": { "type": "boolean", "description": "IsReadPreferenceSecondary: JsonIgnore(value = true) " }, "last_query_ts": { "type": "integer", "description": "Last Query Ts", "format": "int64" }, "getDeleted": { "type": "boolean", "description": "GetDeleted" }, "aggregate": { "description": "Aggregate", "$ref": "#/components/schemas/Aggregate" }, "group_by": { "type": "array", "description": "Group By", "items": { "type": "string", "description": "Group By" } }, "retrieved_fields": { "type": "array", "description": "Retrieved Fields", "items": { "type": "string", "description": "Retrieved Fields" } }, "retrieved_fields_mask": { "type": "boolean", "description": "Retrieved Fields Mask" }, "total_count": { "type": "integer", "description": "Total Count", "format": "int64" }, "dest_page": { "type": "integer", "description": "Dest Page", "format": "int32" }, "next_query": { "type": "object" }, "limit": { "type": "integer", "description": "Limit", "format": "int32" }, "sort_case_insensitive": { "type": "boolean", "description": "Sort Case Insensitive" }, "sort_params": { "type": "object" }, "query_params": { "type": "object" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "Ipv6Route": { "properties": { "destination": { "type": "string", "description": "Destination: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, error = INVALID_IPV6_GATEWAY: IPv6 Gateway is invalid., type = GATEWAYCIDRV6) " }, "via": { "type": "string", "description": "Via: IPAddress(allowEmpty = true, allowLinkLocal = true, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, error = INTERFACE_CONFIG_IPV6_INVALID_HOST_IP: Invalid IPv6 host IP., type = IPV6) " } } }, "BGPGlobalConfigScreen": { "properties": { "prefixes_to_adv_to_wan": { "type": "array", "description": "Prefixes To Adv To Wan", "items": { "type": "string", "description": "Prefixes To Adv To Wan" } }, "prefix_adv_type": { "type": "string", "description": "Prefix Adv Type" }, "stalepath_time": { "type": "integer", "description": "Stalepath Time", "format": "int32" }, "graceful_restart": { "type": "boolean", "description": "Graceful Restart" }, "admin_distance": { "type": "integer", "description": "Admin Distance", "format": "int32" }, "maximum_paths": { "type": "integer", "description": "Maximum Paths", "format": "int32" }, "multi_hop_limit": { "type": "integer", "description": "Multi Hop Limit", "format": "int32" }, "md5_secret": { "type": "string", "description": "Md5 Secret" }, "peer_retry_time": { "type": "integer", "description": "Peer Retry Time", "format": "int32" }, "adv_interval": { "type": "integer", "description": "Adv Interval", "format": "int32" }, "hold_time": { "type": "integer", "description": "Hold Time", "format": "int32" }, "keepalive_time": { "type": "integer", "description": "Keepalive Time", "format": "int32" }, "local_as_num": { "type": "string", "description": "Local As Num" }, "router_id": { "type": "string", "description": "Router Id: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, error = BGP_CONFIG_INVALID_ROUTER_ID: Invalid IP address for router_id. Please use a valid IP Address., type = IP) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "BulkSiteUpdateV2N1": { "properties": { "element_system_limit_profile_id": { "type": "string", "description": "Element System Limit Profile Id" }, "vrf_context_profile_id": { "type": "string", "description": "Vrf Context Profile Id" }, "site_ids": { "type": "array", "description": "Site Ids", "items": { "type": "string", "description": "Site Ids" } }, "type": { "type": "string", "description": "Type", "enum": [ "VRF_CONTEXT_PROFILE_UPDATE", "ELEMENT_SYSTEM_LIMIT_PROFILE_UPDATE" ] }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "BGPPeerConfigScreenV2N6": { "properties": { "route_aggregation": { "description": "Route Aggregation", "$ref": "#/components/schemas/RouteAggregation" }, "advertise_default_route": { "type": "boolean", "description": "Advertise Default Route" }, "update_source_v6": { "type": "string", "description": "Update Source V6: IPAddress(allowEmpty = false, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, PEER_CONFIG_INVALID_UPDATE_SOURCE_IP, type = IPV6) " }, "allow_v6_prefixes": { "type": "boolean", "description": "Allow V6 Prefixes: Required(message = ALLOW_IPV6_PREFIXES_REQUIRED) " }, "allow_v4_prefixes": { "type": "boolean", "description": "Allow V4 Prefixes: Required(message = ALLOW_IPV4_PREFIXES_REQUIRED) " }, "peer_ip_v6": { "type": "string", "description": "Peer Ip V6: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, PEER_CONFIG_INVALID_PEER_IPV6, type = IPV6) " }, "router_id": { "type": "string", "description": "Router Id: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, error = BGP_CONFIG_INVALID_ROUTER_ID: Invalid IP address for router_id. Please use a valid IP Address., type = IP) " }, "vrf_context_id": { "type": "string", "description": "Vrf Context Id: Digits(fraction = 0, integer = 20, error = VRF_CONTEXT_ID_INVALID: VRF Context ID is empty or invalid.) " }, "bgp_config": { "description": "Bgp Config: Valid ", "$ref": "#/components/schemas/BGPConfig" }, "scope": { "type": "string", "description": "Scope", "enum": [ "GLOBAL", "LOCAL" ] }, "shutdown": { "type": "boolean", "description": "Shutdown" }, "update_source": { "type": "string", "description": "Update Source: IPAddress(allowEmpty = false, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, PEER_CONFIG_INVALID_UPDATE_SOURCE_IP, type = IP) " }, "route_map_out_id": { "type": "string", "description": "Route Map Out Id" }, "route_map_in_id": { "type": "string", "description": "Route Map In Id" }, "peer_type": { "type": "string", "description": "Peer Type" }, "remote_as_num": { "type": "string", "description": "Remote As Num: NotEmpty(REQUIRED_REMOTE_AS_NUM) " }, "peer_ip": { "type": "string", "description": "Peer Ip: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, error = PEER_CONFIG_INVALID_PEER_IP: Invalid IP address for routing peer. Please use a valid IPv4 address., type = IP) " }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 1024, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "allow_v6_prefixes", "allow_v4_prefixes", "remote_as_num", "name" ] }, "BGPPeerConfigScreenV2N3": { "properties": { "router_id": { "type": "string", "description": "Router Id: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, error = BGP_CONFIG_INVALID_ROUTER_ID: Invalid IP address for router_id. Please use a valid IP Address., type = IP) " }, "vrf_context_id": { "type": "string", "description": "Vrf Context Id: Digits(fraction = 0, integer = 20, error = VRF_CONTEXT_ID_INVALID: VRF Context ID is empty or invalid.) " }, "bgp_config": { "description": "Bgp Config: Valid ", "$ref": "#/components/schemas/BGPConfig" }, "scope": { "type": "string", "description": "Scope", "enum": [ "GLOBAL", "LOCAL" ] }, "shutdown": { "type": "boolean", "description": "Shutdown" }, "update_source": { "type": "string", "description": "Update Source: IPAddress(allowEmpty = false, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, PEER_CONFIG_INVALID_UPDATE_SOURCE_IP, type = IP) " }, "route_map_out_id": { "type": "string", "description": "Route Map Out Id" }, "route_map_in_id": { "type": "string", "description": "Route Map In Id" }, "peer_type": { "type": "string", "description": "Peer Type" }, "remote_as_num": { "type": "string", "description": "Remote As Num: NotEmpty(REQUIRED_REMOTE_AS_NUM) " }, "peer_ip": { "type": "string", "description": "Peer Ip: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, error = PEER_CONFIG_INVALID_PEER_IP: Invalid IP address for routing peer. Please use a valid IPv4 address., type = IP) " }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 1024, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "remote_as_num", "name" ] }, "BGPPeerConfigScreenV2N4": { "properties": { "update_source_v6": { "type": "string", "description": "Update Source V6: IPAddress(allowEmpty = false, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, PEER_CONFIG_INVALID_UPDATE_SOURCE_IP, type = IPV6) " }, "allow_v6_prefixes": { "type": "boolean", "description": "Allow V6 Prefixes: Required(message = ALLOW_IPV6_PREFIXES_REQUIRED) " }, "allow_v4_prefixes": { "type": "boolean", "description": "Allow V4 Prefixes: Required(message = ALLOW_IPV4_PREFIXES_REQUIRED) " }, "peer_ip_v6": { "type": "string", "description": "Peer Ip V6: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, PEER_CONFIG_INVALID_PEER_IPV6, type = IPV6) " }, "router_id": { "type": "string", "description": "Router Id: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, error = BGP_CONFIG_INVALID_ROUTER_ID: Invalid IP address for router_id. Please use a valid IP Address., type = IP) " }, "vrf_context_id": { "type": "string", "description": "Vrf Context Id: Digits(fraction = 0, integer = 20, error = VRF_CONTEXT_ID_INVALID: VRF Context ID is empty or invalid.) " }, "bgp_config": { "description": "Bgp Config: Valid ", "$ref": "#/components/schemas/BGPConfig" }, "scope": { "type": "string", "description": "Scope", "enum": [ "GLOBAL", "LOCAL" ] }, "shutdown": { "type": "boolean", "description": "Shutdown" }, "update_source": { "type": "string", "description": "Update Source: IPAddress(allowEmpty = false, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, PEER_CONFIG_INVALID_UPDATE_SOURCE_IP, type = IP) " }, "route_map_out_id": { "type": "string", "description": "Route Map Out Id" }, "route_map_in_id": { "type": "string", "description": "Route Map In Id" }, "peer_type": { "type": "string", "description": "Peer Type" }, "remote_as_num": { "type": "string", "description": "Remote As Num: NotEmpty(REQUIRED_REMOTE_AS_NUM) " }, "peer_ip": { "type": "string", "description": "Peer Ip: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, error = PEER_CONFIG_INVALID_PEER_IP: Invalid IP address for routing peer. Please use a valid IPv4 address., type = IP) " }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 1024, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "allow_v6_prefixes", "allow_v4_prefixes", "remote_as_num", "name" ] }, "BGPPeerConfigScreenV2N5": { "properties": { "advertise_default_route": { "type": "boolean", "description": "Advertise Default Route" }, "update_source_v6": { "type": "string", "description": "Update Source V6: IPAddress(allowEmpty = false, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, PEER_CONFIG_INVALID_UPDATE_SOURCE_IP, type = IPV6) " }, "allow_v6_prefixes": { "type": "boolean", "description": "Allow V6 Prefixes: Required(message = ALLOW_IPV6_PREFIXES_REQUIRED) " }, "allow_v4_prefixes": { "type": "boolean", "description": "Allow V4 Prefixes: Required(message = ALLOW_IPV4_PREFIXES_REQUIRED) " }, "peer_ip_v6": { "type": "string", "description": "Peer Ip V6: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, PEER_CONFIG_INVALID_PEER_IPV6, type = IPV6) " }, "router_id": { "type": "string", "description": "Router Id: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, error = BGP_CONFIG_INVALID_ROUTER_ID: Invalid IP address for router_id. Please use a valid IP Address., type = IP) " }, "vrf_context_id": { "type": "string", "description": "Vrf Context Id: Digits(fraction = 0, integer = 20, error = VRF_CONTEXT_ID_INVALID: VRF Context ID is empty or invalid.) " }, "bgp_config": { "description": "Bgp Config: Valid ", "$ref": "#/components/schemas/BGPConfig" }, "scope": { "type": "string", "description": "Scope", "enum": [ "GLOBAL", "LOCAL" ] }, "shutdown": { "type": "boolean", "description": "Shutdown" }, "update_source": { "type": "string", "description": "Update Source: IPAddress(allowEmpty = false, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, PEER_CONFIG_INVALID_UPDATE_SOURCE_IP, type = IP) " }, "route_map_out_id": { "type": "string", "description": "Route Map Out Id" }, "route_map_in_id": { "type": "string", "description": "Route Map In Id" }, "peer_type": { "type": "string", "description": "Peer Type" }, "remote_as_num": { "type": "string", "description": "Remote As Num: NotEmpty(REQUIRED_REMOTE_AS_NUM) " }, "peer_ip": { "type": "string", "description": "Peer Ip: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, error = PEER_CONFIG_INVALID_PEER_IP: Invalid IP address for routing peer. Please use a valid IPv4 address., type = IP) " }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 1024, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "allow_v6_prefixes", "allow_v4_prefixes", "remote_as_num", "name" ] }, "NetworkPolicyRuleQueryFilter": { "properties": { "policyset_id": { "type": "string", "description": "Policyset Id: Digits(fraction = 0, integer = 30, INVALID_POLICYSET_ID) " }, "destination_prefixes_id": { "type": "string", "description": "Destination Prefixes Id: Digits(fraction = 0, integer = 30, error = INVALID_DESTINATION_PREFIXES_ID: Specified destination prefix is invalid.) " }, "source_prefixes_id": { "type": "string", "description": "Source Prefixes Id: Digits(fraction = 0, integer = 30, error = INVALID_SOURCE_PREFIXES_ID: Specified source prefix is invalid.) " }, "paths_allowed": { "description": "Paths Allowed: Valid Required(error = PATHS_ALLOWED_REQUIRED: Paths allowed is required.) ", "$ref": "#/components/schemas/PathsAllowed" }, "service_context": { "description": "Service Context: Valid ", "$ref": "#/components/schemas/ServiceContext" }, "enabled": { "type": "boolean", "description": "Enabled" }, "order_number": { "type": "integer", "description": "Order Number: Min(error = INVALID_ORDER_NUMBER_MINIMUM_VAL: Policy Rule order number should not be less than 1., value = 1L) Max(error = INVALID_ORDER_NUMBER_MAXIMUM_VAL: Policy Rule order number should not be greater than 65535., value = 65535L) " }, "network_context_id": { "type": "string", "description": "Network Context Id: Digits(fraction = 0, integer = 30, error = INVALID_NETWORK_CONTEXT_ID: Specified network context is invalid.) " }, "app_def_ids": { "type": "array", "description": "App Def Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, error = DUPLICATE_APP_DEF_IDS: Duplicate app ids are specified., noTrim = false, regex = , required = false) Size(max = 256, error = APP_DEF_ID_LIST_SIZE_EXCEEDED: Maximum 256 applications can be specified in a rule., min = 0) ", "items": { "type": "string", "description": "App Def Ids" } }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "paths_allowed", "name" ] }, "TcpRule": { "properties": { "client_port": { "description": "Client Port: Valid ", "$ref": "#/components/schemas/Port" }, "server_port": { "description": "Server Port: Valid ", "$ref": "#/components/schemas/Port" }, "client_filters": { "type": "array", "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": { "type": "string", "description": "Client Filters" } }, "server_filters": { "type": "array", "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": { "type": "string", "description": "Server Filters" } } } }, "CellularModuleStatusQueryV2N1": { "properties": { "isReadPreferenceSecondary": { "type": "boolean", "description": "IsReadPreferenceSecondary: JsonIgnore(value = true) " }, "last_query_ts": { "type": "integer", "description": "Last Query Ts", "format": "int64" }, "getDeleted": { "type": "boolean", "description": "GetDeleted" }, "aggregate": { "description": "Aggregate", "$ref": "#/components/schemas/Aggregate" }, "group_by": { "type": "array", "description": "Group By", "items": { "type": "string", "description": "Group By" } }, "retrieved_fields": { "type": "array", "description": "Retrieved Fields", "items": { "type": "string", "description": "Retrieved Fields" } }, "retrieved_fields_mask": { "type": "boolean", "description": "Retrieved Fields Mask" }, "total_count": { "type": "integer", "description": "Total Count", "format": "int64" }, "dest_page": { "type": "integer", "description": "Dest Page", "format": "int32" }, "next_query": { "type": "object" }, "limit": { "type": "integer", "description": "Limit", "format": "int32" }, "sort_case_insensitive": { "type": "boolean", "description": "Sort Case Insensitive" }, "sort_params": { "type": "object" }, "query_params": { "type": "object" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "SNMPAgent": { "properties": { "v3_config": { "description": "V3 Config: Valid Valid ", "$ref": "#/components/schemas/SNMPV3Config" }, "v2_config": { "description": "V2 Config: Valid Valid ", "$ref": "#/components/schemas/SNMPV2Config" }, "description": { "type": "string", "description": "Description: Pattern(error = INVALID_DESCRIPTION: Description contains invalid characters, regexp = ^[^\\\\x00-\\\\x1F\\\\x7F]*$) Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "SimSecurity": { "properties": { "pin": { "type": "string", "description": "Pin: Size(max = 256, error = SIM_SECURITY_CONFIG_INVALID_PIN: Sim security invalid pin - Null pin allowed. For non-null pin, must be numeric with minimum 4 and maximum 8 digits, and must be sent as a base64 encoded string., min = 0) " }, "remove_pin": { "type": "boolean", "description": "Remove Pin: Required(error = SIM_SECURITY_CONFIG_REMOVE_PIN_REQD: Sim security remove pin required. Must be false when pin is non-null and must be true when pin is null.) " }, "slot_number": { "type": "integer", "description": "Slot Number: NotNull(error = SIM_SECURITY_CONFIG_SLOT_NUMBER_REQD: Sim slot number required.) ", "format": "int32" }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "remove_pin", "slot_number", "name" ] }, "SecurityZoneNetworkAssociationV2N1": { "properties": { "element_interfaces": { "type": "array", "description": "Element Interfaces: Valid Valid ", "items": { "$ref": "#/components/schemas/ElementInterfaces" } }, "networks": { "type": "array", "description": "Networks: Valid ", "items": { "$ref": "#/components/schemas/SiteContextV2N1" } }, "zone_id": { "type": "string", "description": "Zone Id: Required(error = SECURITYZONE_INVALID_ZONE: Invalid security zone or zone does not exist.) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "zone_id" ] }, "PppoEInterfaceConfig": { "properties": { "ip_address_type": { "type": "string", "description": "Ip Address Type" }, "reconnection_delay": { "type": "integer", "description": "Reconnection Delay", "format": "int32" }, "host_uniq": { "type": "string", "description": "Host Uniq" }, "service_name": { "type": "string", "description": "Service Name" }, "password": { "type": "string", "description": "Password" }, "username": { "type": "string", "description": "Username" } } }, "PQCKEMConfig": { "properties": { "round_7_algorithms": { "type": "array", "description": "Round_7 Algorithms", "items": { "type": "string", "description": "Round 7 Algorithms" } }, "round_6_algorithms": { "type": "array", "description": "Round_6 Algorithms", "items": { "type": "string", "description": "Round 6 Algorithms" } }, "round_5_algorithms": { "type": "array", "description": "Round_5 Algorithms", "items": { "type": "string", "description": "Round 5 Algorithms" } }, "round_4_algorithms": { "type": "array", "description": "Round_4 Algorithms", "items": { "type": "string", "description": "Round 4 Algorithms" } }, "round_3_algorithms": { "type": "array", "description": "Round_3 Algorithms", "items": { "type": "string", "description": "Round 3 Algorithms" } }, "round_2_algorithms": { "type": "array", "description": "Round_2 Algorithms", "items": { "type": "string", "description": "Round 2 Algorithms" } }, "round_1_algorithms": { "type": "array", "description": "Round_1 Algorithms", "items": { "type": "string", "description": "Round 1 Algorithms" } }, "enabled": { "type": "boolean", "description": "Enabled" } } }, "InterfaceScreenV4N6": { "properties": { "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "service_link_config": { "description": "Service Link Config: Valid Valid ", "$ref": "#/components/schemas/ServiceLinkV1" }, "bypass_pair": { "description": "Bypass Pair", "$ref": "#/components/schemas/BypassPairV2" }, "network_context_id": { "type": "string", "description": "Network Context Id" }, "parent": { "type": "string", "description": "Parent" }, "pppoe_config": { "description": "Pppoe Config: Valid Valid ", "$ref": "#/components/schemas/PppoE" }, "sub_interface": { "description": "Sub Interface: Valid ", "$ref": "#/components/schemas/SubInterface" }, "bound_interfaces": { "type": "array", "description": "Bound Interfaces", "items": { "type": "string", "description": "Bound Interfaces" } }, "used_for": { "type": "string", "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) " }, "nat_port": { "type": "integer", "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" }, "nat_address": { "type": "string", "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) " }, "admin_up": { "type": "boolean", "description": "Admin Up" }, "ethernet_port": { "description": "Ethernet Port", "$ref": "#/components/schemas/EthernetPort" }, "dhcp_relay": { "description": "Dhcp Relay: Valid ", "$ref": "#/components/schemas/DHCPRelay" }, "ipv4_config": { "description": "Ipv4 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv4Config" }, "mtu": { "type": "integer", "description": "Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: MTU is not in the valid range., min = 0L) " }, "mac_address": { "type": "string", "description": "Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) " }, "site_wan_interface_ids": { "type": "array", "description": "Site Wan Interface Ids", "items": { "type": "string", "description": "Site Wan Interface Ids" } }, "attached_lan_networks": { "type": "array", "description": "Attached Lan Networks: Valid ", "items": { "$ref": "#/components/schemas/LanNetworkVlanMapping" } }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[InterfaceType], error = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "scope", "used_for", "type" ] }, "BandwidthAllocationSchemeV2": { "properties": { "business_priorities": { "type": "array", "description": "Business Priorities", "items": { "$ref": "#/components/schemas/BusinessPriorityV2" } }, "bandwidth_range": { "description": "Bandwidth Range", "$ref": "#/components/schemas/BandwidthRange" } } }, "InterfaceScreenV4N7": { "properties": { "nat_pools": { "type": "array", "description": "Nat Pools: Valid ", "items": { "$ref": "#/components/schemas/NatPool" } }, "devicemgmt_policysetstack_id": { "type": "string", "description": "Devicemgmt Policysetstack Id: Digits(fraction = 0, integer = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) " }, "nat_zone_id": { "type": "string", "description": "Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "service_link_config": { "description": "Service Link Config: Valid Valid ", "$ref": "#/components/schemas/ServiceLinkV1" }, "bypass_pair": { "description": "Bypass Pair", "$ref": "#/components/schemas/BypassPairV2" }, "network_context_id": { "type": "string", "description": "Network Context Id" }, "parent": { "type": "string", "description": "Parent" }, "pppoe_config": { "description": "Pppoe Config: Valid Valid ", "$ref": "#/components/schemas/PppoE" }, "sub_interface": { "description": "Sub Interface: Valid ", "$ref": "#/components/schemas/SubInterface" }, "bound_interfaces": { "type": "array", "description": "Bound Interfaces", "items": { "type": "string", "description": "Bound Interfaces" } }, "used_for": { "type": "string", "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) " }, "nat_port": { "type": "integer", "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" }, "nat_address": { "type": "string", "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) " }, "admin_up": { "type": "boolean", "description": "Admin Up" }, "ethernet_port": { "description": "Ethernet Port", "$ref": "#/components/schemas/EthernetPort" }, "dhcp_relay": { "description": "Dhcp Relay: Valid ", "$ref": "#/components/schemas/DHCPRelay" }, "ipv4_config": { "description": "Ipv4 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv4Config" }, "mtu": { "type": "integer", "description": "Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: MTU is not in the valid range., min = 0L) " }, "mac_address": { "type": "string", "description": "Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) " }, "site_wan_interface_ids": { "type": "array", "description": "Site Wan Interface Ids", "items": { "type": "string", "description": "Site Wan Interface Ids" } }, "attached_lan_networks": { "type": "array", "description": "Attached Lan Networks: Valid ", "items": { "$ref": "#/components/schemas/LanNetworkVlanMapping" } }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[InterfaceType], error = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "scope", "used_for", "type" ] }, "SecurityProfileGroupQueryFilter": { "properties": { "dns_security_profile": { "description": "Dns Security Profile", "$ref": "#/components/schemas/SecurityProfile" }, "url_filtering_profile": { "description": "Url Filtering Profile", "$ref": "#/components/schemas/SecurityProfile" }, "spyware_profile": { "description": "Spyware Profile", "$ref": "#/components/schemas/SecurityProfile" }, "vulnerability_profile": { "description": "Vulnerability Profile", "$ref": "#/components/schemas/SecurityProfile" }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 55, message = Profile Group name must be less than 56 characters, min = 0) " }, "predefined": { "type": "boolean", "description": "Predefined" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "InterfaceScreenV4N8": { "properties": { "service_link_config": { "description": "Service Link Config: Valid Valid ", "$ref": "#/components/schemas/ServiceLinkV3" }, "nat_pools": { "type": "array", "description": "Nat Pools: Valid ", "items": { "$ref": "#/components/schemas/NatPool" } }, "devicemgmt_policysetstack_id": { "type": "string", "description": "Devicemgmt Policysetstack Id: Digits(fraction = 0, integer = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) " }, "nat_zone_id": { "type": "string", "description": "Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "bypass_pair": { "description": "Bypass Pair", "$ref": "#/components/schemas/BypassPairV2" }, "network_context_id": { "type": "string", "description": "Network Context Id" }, "parent": { "type": "string", "description": "Parent" }, "pppoe_config": { "description": "Pppoe Config: Valid Valid ", "$ref": "#/components/schemas/PppoE" }, "sub_interface": { "description": "Sub Interface: Valid ", "$ref": "#/components/schemas/SubInterface" }, "bound_interfaces": { "type": "array", "description": "Bound Interfaces", "items": { "type": "string", "description": "Bound Interfaces" } }, "used_for": { "type": "string", "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) " }, "nat_port": { "type": "integer", "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" }, "nat_address": { "type": "string", "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) " }, "admin_up": { "type": "boolean", "description": "Admin Up" }, "ethernet_port": { "description": "Ethernet Port", "$ref": "#/components/schemas/EthernetPort" }, "dhcp_relay": { "description": "Dhcp Relay: Valid ", "$ref": "#/components/schemas/DHCPRelay" }, "ipv4_config": { "description": "Ipv4 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv4Config" }, "mtu": { "type": "integer", "description": "Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: MTU is not in the valid range., min = 0L) " }, "mac_address": { "type": "string", "description": "Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) " }, "site_wan_interface_ids": { "type": "array", "description": "Site Wan Interface Ids", "items": { "type": "string", "description": "Site Wan Interface Ids" } }, "attached_lan_networks": { "type": "array", "description": "Attached Lan Networks: Valid ", "items": { "$ref": "#/components/schemas/LanNetworkVlanMapping" } }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[InterfaceType], error = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "scope", "used_for", "type" ] }, "InterfaceScreenV4N9": { "properties": { "directed_broadcast": { "type": "boolean", "description": "Directed Broadcast" }, "service_link_config": { "description": "Service Link Config: Valid Valid ", "$ref": "#/components/schemas/ServiceLinkV3" }, "nat_pools": { "type": "array", "description": "Nat Pools: Valid ", "items": { "$ref": "#/components/schemas/NatPool" } }, "devicemgmt_policysetstack_id": { "type": "string", "description": "Devicemgmt Policysetstack Id: Digits(fraction = 0, integer = 30, INVALID_DEVICEMGMT_POLICYSETSTACK_ID) " }, "nat_zone_id": { "type": "string", "description": "Nat Zone Id: Digits(fraction = 0, integer = 30, INVALID_NAT_POLICY_ZONE) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "bypass_pair": { "description": "Bypass Pair", "$ref": "#/components/schemas/BypassPairV2" }, "network_context_id": { "type": "string", "description": "Network Context Id" }, "parent": { "type": "string", "description": "Parent" }, "pppoe_config": { "description": "Pppoe Config: Valid Valid ", "$ref": "#/components/schemas/PppoE" }, "sub_interface": { "description": "Sub Interface: Valid ", "$ref": "#/components/schemas/SubInterface" }, "bound_interfaces": { "type": "array", "description": "Bound Interfaces", "items": { "type": "string", "description": "Bound Interfaces" } }, "used_for": { "type": "string", "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) " }, "nat_port": { "type": "integer", "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" }, "nat_address": { "type": "string", "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) " }, "admin_up": { "type": "boolean", "description": "Admin Up" }, "ethernet_port": { "description": "Ethernet Port", "$ref": "#/components/schemas/EthernetPort" }, "dhcp_relay": { "description": "Dhcp Relay: Valid ", "$ref": "#/components/schemas/DHCPRelay" }, "ipv4_config": { "description": "Ipv4 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv4Config" }, "mtu": { "type": "integer", "description": "Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: MTU is not in the valid range., min = 0L) " }, "mac_address": { "type": "string", "description": "Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) " }, "site_wan_interface_ids": { "type": "array", "description": "Site Wan Interface Ids", "items": { "type": "string", "description": "Site Wan Interface Ids" } }, "attached_lan_networks": { "type": "array", "description": "Attached Lan Networks: Valid ", "items": { "$ref": "#/components/schemas/LanNetworkVlanMapping" } }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[InterfaceType], error = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "scope", "used_for", "type" ] }, "InterfaceScreenV4N2": { "properties": { "bypass_pair": { "description": "Bypass Pair", "$ref": "#/components/schemas/BypassPairV2" }, "network_context_id": { "type": "string", "description": "Network Context Id" }, "parent": { "type": "string", "description": "Parent" }, "pppoe_config": { "description": "Pppoe Config: Valid Valid ", "$ref": "#/components/schemas/PppoE" }, "sub_interface": { "description": "Sub Interface: Valid ", "$ref": "#/components/schemas/SubInterface" }, "bound_interfaces": { "type": "array", "description": "Bound Interfaces", "items": { "type": "string", "description": "Bound Interfaces" } }, "used_for": { "type": "string", "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) " }, "nat_port": { "type": "integer", "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" }, "nat_address": { "type": "string", "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) " }, "admin_up": { "type": "boolean", "description": "Admin Up" }, "ethernet_port": { "description": "Ethernet Port", "$ref": "#/components/schemas/EthernetPort" }, "dhcp_relay": { "description": "Dhcp Relay: Valid ", "$ref": "#/components/schemas/DHCPRelay" }, "ipv4_config": { "description": "Ipv4 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv4Config" }, "mtu": { "type": "integer", "description": "Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: MTU is not in the valid range., min = 0L) " }, "mac_address": { "type": "string", "description": "Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "site_wan_interface_ids": { "type": "array", "description": "Site Wan Interface Ids", "items": { "type": "string", "description": "Site Wan Interface Ids" } }, "attached_lan_networks": { "type": "array", "description": "Attached Lan Networks: Valid ", "items": { "$ref": "#/components/schemas/LanNetworkVlanMapping" } }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[InterfaceType], error = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "used_for", "type" ] }, "InterfaceScreenV4N3": { "properties": { "service_link_config": { "description": "Service Link Config: Valid Valid ", "$ref": "#/components/schemas/ServiceLinkV1" }, "bypass_pair": { "description": "Bypass Pair", "$ref": "#/components/schemas/BypassPairV2" }, "network_context_id": { "type": "string", "description": "Network Context Id" }, "parent": { "type": "string", "description": "Parent" }, "pppoe_config": { "description": "Pppoe Config: Valid Valid ", "$ref": "#/components/schemas/PppoE" }, "sub_interface": { "description": "Sub Interface: Valid ", "$ref": "#/components/schemas/SubInterface" }, "bound_interfaces": { "type": "array", "description": "Bound Interfaces", "items": { "type": "string", "description": "Bound Interfaces" } }, "used_for": { "type": "string", "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) " }, "nat_port": { "type": "integer", "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" }, "nat_address": { "type": "string", "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) " }, "admin_up": { "type": "boolean", "description": "Admin Up" }, "ethernet_port": { "description": "Ethernet Port", "$ref": "#/components/schemas/EthernetPort" }, "dhcp_relay": { "description": "Dhcp Relay: Valid ", "$ref": "#/components/schemas/DHCPRelay" }, "ipv4_config": { "description": "Ipv4 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv4Config" }, "mtu": { "type": "integer", "description": "Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: MTU is not in the valid range., min = 0L) " }, "mac_address": { "type": "string", "description": "Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "site_wan_interface_ids": { "type": "array", "description": "Site Wan Interface Ids", "items": { "type": "string", "description": "Site Wan Interface Ids" } }, "attached_lan_networks": { "type": "array", "description": "Attached Lan Networks: Valid ", "items": { "$ref": "#/components/schemas/LanNetworkVlanMapping" } }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[InterfaceType], error = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "used_for", "type" ] }, "InterfaceScreenV4N4": { "properties": { "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "service_link_config": { "description": "Service Link Config: Valid Valid ", "$ref": "#/components/schemas/ServiceLinkV1" }, "bypass_pair": { "description": "Bypass Pair", "$ref": "#/components/schemas/BypassPairV2" }, "network_context_id": { "type": "string", "description": "Network Context Id" }, "parent": { "type": "string", "description": "Parent" }, "pppoe_config": { "description": "Pppoe Config: Valid Valid ", "$ref": "#/components/schemas/PppoE" }, "sub_interface": { "description": "Sub Interface: Valid ", "$ref": "#/components/schemas/SubInterface" }, "bound_interfaces": { "type": "array", "description": "Bound Interfaces", "items": { "type": "string", "description": "Bound Interfaces" } }, "used_for": { "type": "string", "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) " }, "nat_port": { "type": "integer", "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" }, "nat_address": { "type": "string", "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) " }, "admin_up": { "type": "boolean", "description": "Admin Up" }, "ethernet_port": { "description": "Ethernet Port", "$ref": "#/components/schemas/EthernetPort" }, "dhcp_relay": { "description": "Dhcp Relay: Valid ", "$ref": "#/components/schemas/DHCPRelay" }, "ipv4_config": { "description": "Ipv4 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv4Config" }, "mtu": { "type": "integer", "description": "Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: MTU is not in the valid range., min = 0L) " }, "mac_address": { "type": "string", "description": "Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "site_wan_interface_ids": { "type": "array", "description": "Site Wan Interface Ids", "items": { "type": "string", "description": "Site Wan Interface Ids" } }, "attached_lan_networks": { "type": "array", "description": "Attached Lan Networks: Valid ", "items": { "$ref": "#/components/schemas/LanNetworkVlanMapping" } }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[InterfaceType], error = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "scope", "used_for", "type" ] }, "InterfaceScreenV4N5": { "properties": { "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "service_link_config": { "description": "Service Link Config: Valid Valid ", "$ref": "#/components/schemas/ServiceLinkV1" }, "bypass_pair": { "description": "Bypass Pair", "$ref": "#/components/schemas/BypassPairV2" }, "network_context_id": { "type": "string", "description": "Network Context Id" }, "parent": { "type": "string", "description": "Parent" }, "pppoe_config": { "description": "Pppoe Config: Valid Valid ", "$ref": "#/components/schemas/PppoE" }, "sub_interface": { "description": "Sub Interface: Valid ", "$ref": "#/components/schemas/SubInterface" }, "bound_interfaces": { "type": "array", "description": "Bound Interfaces", "items": { "type": "string", "description": "Bound Interfaces" } }, "used_for": { "type": "string", "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) " }, "nat_port": { "type": "integer", "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" }, "nat_address": { "type": "string", "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) " }, "admin_up": { "type": "boolean", "description": "Admin Up" }, "ethernet_port": { "description": "Ethernet Port", "$ref": "#/components/schemas/EthernetPort" }, "dhcp_relay": { "description": "Dhcp Relay: Valid ", "$ref": "#/components/schemas/DHCPRelay" }, "ipv4_config": { "description": "Ipv4 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv4Config" }, "mtu": { "type": "integer", "description": "Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: MTU is not in the valid range., min = 0L) " }, "mac_address": { "type": "string", "description": "Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) " }, "site_wan_interface_ids": { "type": "array", "description": "Site Wan Interface Ids", "items": { "type": "string", "description": "Site Wan Interface Ids" } }, "attached_lan_networks": { "type": "array", "description": "Attached Lan Networks: Valid ", "items": { "$ref": "#/components/schemas/LanNetworkVlanMapping" } }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[InterfaceType], error = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "scope", "used_for", "type" ] }, "LicenseCategory": { "properties": { "xtra_large": { "description": "Xtra Large", "$ref": "#/components/schemas/LicenseCount" }, "large": { "description": "Large", "$ref": "#/components/schemas/LicenseCount" }, "medium": { "description": "Medium", "$ref": "#/components/schemas/LicenseCount" }, "small": { "description": "Small", "$ref": "#/components/schemas/LicenseCount" }, "very_small": { "description": "Very Small", "$ref": "#/components/schemas/LicenseCount" } } }, "ElementV3": { "properties": { "led_config": { "description": "Led Config: Valid ", "$ref": "#/components/schemas/LedConfig" }, "override_indicator": { "type": "array", "description": "Override Indicator", "items": { "type": "string", "description": "Override Indicator" } }, "switch_config": { "description": "Switch Config: Valid ", "$ref": "#/components/schemas/SwitchConfig" }, "device_profile_id": { "type": "string", "description": "Device Profile Id" }, "main_power_usage_threshold": { "type": "integer", "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" }, "fips_mode_change_start_time": { "type": "integer", "description": "Fips Mode Change Start Time", "format": "int64" }, "fips_mode": { "type": "string", "description": "Fips Mode", "enum": [ "none", "fips", "non_fips" ] }, "admin_suspend_state": { "type": "string", "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" ] }, "spoke_ha_config": { "description": "Spoke Ha Config: Valid ", "$ref": "#/components/schemas/SpokeHAConfigV2" }, "admin_renew_state": { "type": "string", "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" ] }, "vpn_to_vpn_forwarding": { "type": "boolean", "description": "Vpn To Vpn Forwarding" }, "nat_policysetstack_id": { "type": "string", "description": "Nat Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_NAT_POLICYSETSTACK_ID: Invalid nat policy set stack id.) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "priority_policysetstack_id": { "type": "string", "description": "Priority Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_PRIORITY_POLICYSETSTACK_ID: Invalid priority policy set stack id) " }, "network_policysetstack_id": { "type": "string", "description": "Network Policysetstack Id: Digits(fraction = 0, integer = 20, error = INVALID_NETWORK_POLICYSETSTACK_ID: Invalid network policy set stack id) " }, "deployment_op": { "type": "string", "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" ] }, "admin_action": { "type": "string", "description": "Admin Action", "enum": [ "ALLOCATE", "CLAIM", "BOUND", "UNBOUND", "DECLAIM", "RETURN", "REVOKE", "RETIRE", "STOCK", "UPGRADE", "REMANUFACTURE", "DEFAULT", "INVALID" ] }, "connected": { "type": "boolean", "description": "Connected" }, "l3_lan_forwarding": { "type": "boolean", "description": "L3 Lan Forwarding" }, "l3_direct_private_wan_forwarding": { "type": "boolean", "description": "L3 Direct Private Wan Forwarding" }, "cluster_id": { "type": "string", "description": "Cluster Id" }, "allowed_roles": { "type": "array", "description": "Allowed Roles", "items": { "type": "string", "description": "Allowed Roles", "enum": [ "NONE", "HUB", "SPOKE", "PA_WE_BR", "PA_WE_DC", "PA_CONN" ] } }, "state": { "type": "string", "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", "ACTIVE_DECLAIMED" ] }, "role": { "type": "string", "description": "Role", "enum": [ "NONE", "HUB", "SPOKE", "PA_WE_BR", "PA_WE_DC", "PA_CONN" ] }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "model_name": { "type": "string", "description": "Model Name" }, "serial_number": { "type": "string", "description": "Serial Number" }, "hw_id": { "type": "string", "description": "Hw Id" }, "software_version": { "type": "string", "description": "Software Version" }, "site_id": { "type": "string", "description": "Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) NotNull " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "site_id" ] }, "SiteSecurityPolicyV2PrefixAssociation": { "properties": { "ipv4_prefixes": { "type": "array", "description": "Ipv4 Prefixes: ListIPAddress(bcast = DENY, listMaxSize = 0, error = INVALID_IPV4_PREFIX: Invalid IPv4 Prefix., required = false, type = APP_GATEWAYCIDR) ", "items": { "type": "string", "description": "Ipv4 Prefixes" } }, "prefix_id": { "type": "string", "description": "Prefix Id" }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "InterfaceScreenV4N1": { "properties": { "bypass_pair": { "description": "Bypass Pair", "$ref": "#/components/schemas/BypassPair" }, "network_context_id": { "type": "string", "description": "Network Context Id" }, "parent": { "type": "string", "description": "Parent" }, "pppoe_config": { "description": "Pppoe Config: Valid Valid ", "$ref": "#/components/schemas/PppoE" }, "sub_interface": { "description": "Sub Interface: Valid ", "$ref": "#/components/schemas/SubInterface" }, "bound_interfaces": { "type": "array", "description": "Bound Interfaces", "items": { "type": "string", "description": "Bound Interfaces" } }, "used_for": { "type": "string", "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) " }, "nat_port": { "type": "integer", "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" }, "nat_address": { "type": "string", "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) " }, "admin_up": { "type": "boolean", "description": "Admin Up" }, "ethernet_port": { "description": "Ethernet Port", "$ref": "#/components/schemas/EthernetPort" }, "dhcp_relay": { "description": "Dhcp Relay: Valid ", "$ref": "#/components/schemas/DHCPRelay" }, "ipv4_config": { "description": "Ipv4 Config: Valid Valid ", "$ref": "#/components/schemas/Ipv4Config" }, "mtu": { "type": "integer", "description": "Mtu: Range(max = 9216L, error = INTERFACE_CONFIG_INVALID_MTU: MTU is not in the valid range., min = 0L) " }, "mac_address": { "type": "string", "description": "Mac Address: Pattern(error = INTERFACE_CONFIG_INVALID_MAC: Invalid mac address syntax., regexp = ([0-9a-f]{2}[:]){5}([0-9a-f]{2})) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "site_wan_interface_ids": { "type": "array", "description": "Site Wan Interface Ids", "items": { "type": "string", "description": "Site Wan Interface Ids" } }, "attached_lan_networks": { "type": "array", "description": "Attached Lan Networks: Valid ", "items": { "$ref": "#/components/schemas/LanNetworkVlanMapping" } }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[InterfaceType], error = INVALID_PORT_TYPE: Port type is not valid., nullAllowed = false) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "used_for", "type" ] }, "NTPTemplate": { "properties": { "default_template": { "type": "boolean", "description": "Default Template" }, "ntp_servers": { "type": "array", "description": "Ntp Servers: NotEmpty(error = NTP_CONFIG_INVALID_SERVER_SIZE: A minimum of 1 and a maximum of 10 NTP servers can be configured.) Size(max = 10, error = NTP_CONFIG_INVALID_SERVER_SIZE: A minimum of 1 and a maximum of 10 NTP servers can be configured., min = 1) Valid ", "items": { "$ref": "#/components/schemas/NTPServer" } }, "tags": { "type": "array", "description": "Tags", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = NTP_CONFIG_DESCRIPTION_INVALID: NTP description is invalid. The maximum length is 256., min = 0) " }, "name": { "type": "string", "description": "Name: NotEmpty(error = NTP_CONFIG_NAME_REQD: Name is mandatory for NTP configuration.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "ntp_servers", "name" ] }, "Group": { "properties": { "is_active_rp": { "type": "boolean", "description": "Is Active Rp" }, "ipv4_prefix": { "type": "string", "description": "Ipv4 Prefix" } } }, "LANNetworkV3": { "properties": { "network_context_id": { "type": "string", "description": "Network Context Id: Digits(fraction = 0, integer = 30, error = INVALID_NETWORK_CONTEXT_ID: Specified network context is invalid.) " }, "ipv4_config": { "description": "Ipv4 Config: Valid ", "$ref": "#/components/schemas/LanNetworkIPv4Config" }, "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "scope", "name" ] }, "ProbeConfigScreenV2N1": { "properties": { "enabled": { "type": "boolean", "description": "Enabled" }, "endpoints": { "type": "array", "description": "Endpoints: Required(error = PROBE_ENDPOINTS_REQUIRED: Probe endpoint configuration is required) Valid ", "items": { "$ref": "#/components/schemas/ProbeEndpointV2N1" } }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "endpoints", "name" ] }, "VRFContextProfileScreen": { "properties": { "vrf_context_route_leak_rules": { "type": "array", "description": "Vrf Context Route Leak Rules: Valid ", "items": { "$ref": "#/components/schemas/VRFContextRouteLeakRule" } }, "vrf_context_ids": { "type": "array", "description": "Vrf Context Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, INVALID_STRING, noTrim = false, regex = , required = false) ", "items": { "type": "string", "description": "Vrf Context Ids" } }, "default_vrf_context_profile": { "type": "boolean", "description": "Default Vrf Context Profile: JsonIgnore(value = true) " }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = VRF_CONTEXT_PROFILE_DESCRIPTION_INVALID: Vrf profile description exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: NotBlank(error = VRF_CONTEXT_PROFILE_NAME_INVALID: Vrf context profile name is invalid) Size(max = 128, error = VRF_CONTEXT_PROFILE_NAME_EXCEEDS_LIMIT: Vrf context profile name exceeds limit, min = 0) Pattern(error = VRF_CONTEXT_PROFILE_NAME_INVALID: Vrf context profile name is invalid, regexp = ^[A-Za-z][A-Za-z0-9_\\\\s-]*$) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "FailureInfo": { "properties": { "failure_details": { "type": "string", "description": "Failure Details" }, "application_sig_file": { "type": "string", "description": "Application Sig File" } } }, "DeviceIdDictionary": { "properties": { "category": { "type": "string", "description": "Category" }, "type": { "type": "string", "description": "Type" }, "stale": { "type": "boolean", "description": "Stale" }, "name": { "type": "string", "description": "Name" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "ServiceLinkV1": { "properties": { "last_parent": { "type": "string", "description": "Last Parent: JsonIgnore(value = true) " }, "parent": { "type": "string", "description": "Parent: JsonIgnore(value = true) " }, "ipsec_config": { "description": "Ipsec Config: Valid ", "$ref": "#/components/schemas/IPSECConfig" }, "peer": { "description": "Peer: Valid ", "$ref": "#/components/schemas/PeerInfo" }, "service_endpoint_id": { "type": "string", "description": "Service Endpoint Id" }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[ServiceLinkType], INVALID_SERVICE_LINK_TYPE, nullAllowed = false) ", "enum": [ "IPSEC", "GRE", "GENEVE" ] } }, "required": [ "type" ] }, "SecurityPolicyV2SetStackScreen": { "properties": { "defaultrule_policyset_id": { "type": "string", "description": "Defaultrule Policyset Id" }, "policyset_ids": { "type": "array", "description": "Policyset Ids: Size(max = 4, error = POLICYSETSTACK_CONFIG_INVALID_POLICYSETLIST_SIZE: Invalid number of policysets. Should be between 1-4., min = 0) ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, error = POLICYSETSTACK_CONFIG_DUPLICATE_POLICYSETID: PolicySet Stack configuration is not valid. Duplicate policy set id present in the policy set list., noTrim = false, regex = [0-9]{1,30}, required = false) ", "items": { "type": "string", "description": "Policyset Ids" } }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "SitePrefixAssociationQueryFilterV2N1": { "properties": { "site_id": { "type": "string", "description": "Site Id" }, "ipv6_prefixes": { "type": "array", "description": "Ipv6 Prefixes: ListIPv6Address(bcast = DENY, listMaxSize = 0, error = INVALID_IPV6_PREFIX: Invalid ipv6 prefix, required = false, type = GATEWAYCIDRV6) ", "items": { "type": "string", "description": "Ipv6 Prefixes" } }, "ipv4_prefixes": { "type": "array", "description": "Ipv4 Prefixes: ListIPAddress(bcast = DENY, listMaxSize = 0, error = INVALID_IPV4_PREFIX: Invalid IPv4 Prefix., required = false, type = APP_GATEWAYCIDR) ", "items": { "type": "string", "description": "Ipv4 Prefixes" } }, "prefix_id": { "type": "string", "description": "Prefix Id" }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "GlobalPrefixQueryFilter": { "properties": { "ipv4_prefixes": { "type": "array", "description": "Ipv4 Prefixes: ListIPAddress(bcast = DENY, listMaxSize = 0, error = INVALID_PREFIX: Prefix is not valid OR not within the valid prefix range., required = false, type = PREFIXCIDR_ALL) ", "items": { "type": "string", "description": "Ipv4 Prefixes" } }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "ElementSecurityZone": { "properties": { "waninterface_ids": { "type": "array", "description": "Waninterface Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, error = ELEMENT_SECURITYZONE_INVALID_WANINTERFACE_IDS: Specified site wan interface ids are invalid., noTrim = false, regex = [0-9]{1,30}, required = false) ", "items": { "type": "string", "description": "Waninterface Ids" } }, "wanoverlay_ids": { "type": "array", "description": "Wanoverlay Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, error = ELEMENT_SECURITYZONE_INVALID_WANOVERLAY_IDS: Specified wanoverlay ids are invalid., noTrim = false, regex = [0-9]{1,30}, required = false) ", "items": { "type": "string", "description": "Wanoverlay Ids" } }, "interface_ids": { "type": "array", "description": "Interface Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, error = ELEMENT_SECURITYZONE_INVALID_INTERFACE_IDS: Specified interface ids are invalid., noTrim = false, regex = [0-9]{1,30}, required = false) ", "items": { "type": "string", "description": "Interface Ids" } }, "lannetwork_ids": { "type": "array", "description": "Lannetwork Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, error = ELEMENT_SECURITYZONE_INVALID_LANNETWORK_IDS: Specified lan network ids are invalid., noTrim = false, regex = [0-9]{1,30}, required = false) ", "items": { "type": "string", "description": "Lannetwork Ids" } }, "zone_id": { "type": "string", "description": "Zone Id: Required(error = ELEMENT_SECURITYZONE_ZONEID_REQUIRED: Security zone id is required for element level association.) Digits(fraction = 0, integer = 30, ELEMENT_SECURITYZONE_INVALID_ZONEID) " }, "site_id": { "type": "string", "description": "Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) NotNull " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "zone_id", "site_id" ] }, "PrismaAccessConfigQueryResponse": { "properties": { "remote_networks": { "type": "array", "description": "Remote Networks: Valid Valid ", "items": { "$ref": "#/components/schemas/RemoteNetwork" } }, "site_id": { "type": "string", "description": "Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) NotNull " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "site_id" ] }, "NTPTemplateSync": { "properties": { "ntp_template_sync_type": { "type": "string", "description": "Ntp Template Sync Type", "enum": [ "APPLY_TO_ALL_ELEMENTS", "APPLY_TO_MATCHING_TEMPLATE_NAMES", "APPLY_TO_MATCHING_SERVERS" ] }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "BasePolicySet": { "properties": { "policy_rules": { "type": "array", "description": "Policy Rules", "items": { "$ref": "#/components/schemas/BasePolicyRule" } }, "send_to_element": { "type": "boolean", "description": "Send To Element" }, "clone_from": { "type": "string", "description": "Clone From: Digits(fraction = 0, integer = 20, INVALID_CLONE_FROM) " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "region": { "type": "string", "description": "Region" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "boolean", "description": "Disabled" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "boolean", "description": "Inactive" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string" } }, "required": [ "name" ] }, "DemStatusQueryResponse": { "properties": { "dem_enabled": { "type": "boolean", "description": "Dem Enabled" }, "site_id": { "type": "string", "description": "Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) NotNull " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "site_id" ] }, "PANetwork": { "properties": { "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "QueryParam": { "properties": { "zone_id": { "type": "string", "description": "Zone Id: Required(error = SECURITYZONE_INVALID_QUERY: Query filter does not exist.) " } }, "required": [ "zone_id" ] }, "SourceSideRp": { "properties": { "groups": { "type": "array", "description": "Groups", "items": { "$ref": "#/components/schemas/SourceSideGroup" } }, "ipv4_address": { "type": "string", "description": "Ipv4 Address" } } }, "VPLAdminState": { "properties": { "enabled": { "type": "boolean", "description": "Enabled" }, "al_id": { "type": "string", "description": "Al Id" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "SiteQuery": { "properties": { "view": { "description": "View", "$ref": "#/components/schemas/View" }, "region_group_by": { "type": "string", "description": "Region Group By" }, "isReadPreferenceSecondary": { "type": "boolean", "description": "IsReadPreferenceSecondary: JsonIgnore(value = true) " }, "last_query_ts": { "type": "integer", "description": "Last Query Ts", "format": "int64" }, "getDeleted": { "type": "boolean", "description": "GetDeleted" }, "aggregate": { "description": "Aggregate", "$ref": "#/components/schemas/Aggregate" }, "group_by": { "type": "array", "description": "Group By", "items": { "type": "string", "description": "Group By" } }, "retrieved_fields": { "type": "array", "description": "Retrieved Fields", "items": { "type": "string", "description": "Retrieved Fields" } }, "retrieved_fields_mask": { "type": "boolean", "description": "Retrieved Fields Mask" }, "total_count": { "type": "integer", "description": "Total Count", "format": "int64" }, "dest_page": { "type": "integer", "description": "Dest Page", "format": "int32" }, "next_query": { "type": "object" }, "limit": { "type": "integer", "description": "Limit", "format": "int32" }, "sort_case_insensitive": { "type": "boolean", "description": "Sort Case Insensitive" }, "sort_params": { "type": "object" }, "query_params": { "type": "object" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "LANNetworkScreenV3": { "properties": { "network_context_id": { "type": "string", "description": "Network Context Id: Digits(fraction = 0, integer = 30, error = INVALID_NETWORK_CONTEXT_ID: Specified network context is invalid.) " }, "ipv4_config": { "description": "Ipv4 Config: Valid ", "$ref": "#/components/schemas/LanNetworkIPv4Config" }, "scope": { "type": "string", "description": "Scope: ValidateEnum(enumClass = classOf[NetworkScope], message = Invalid enum string., nullAllowed = false) ", "enum": [ "GLOBAL", "LOCAL" ] }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "scope", "name" ] }, "MulticastNeighbor": { "properties": { "expires": { "type": "string", "description": "Expires" }, "uptime": { "type": "string", "description": "Uptime" }, "dr": { "type": "boolean", "description": "Dr" }, "dr_prio": { "type": "string", "description": "Dr Prio" }, "address": { "type": "string", "description": "Address" } } }, "DHCPServerScreen": { "properties": { "custom_options": { "type": "array", "description": "Custom Options: Valid ", "items": { "$ref": "#/components/schemas/BaseCustomDHCPOptions" } }, "static_mappings": { "type": "array", "description": "Static Mappings: Valid ", "items": { "$ref": "#/components/schemas/StaticMapping" } }, "ip_ranges": { "type": "array", "description": "Ip Ranges: NotNull(error = DHCPSERVER_CONFIG_IP_RANGE_MISSING: Provide valid IPv4/IPv6 address range for defined subnet.) Size(max = 2147483647, error = DHCPSERVER_CONFIG_IP_RANGE_MISSING: Provide valid IPv4/IPv6 address range for defined subnet., min = 1) Valid ", "items": { "$ref": "#/components/schemas/IPRange" } }, "max_lease_time": { "type": "integer", "description": "Max Lease Time: Min(error = DHCPSERVER_CONFIG_UNSUPPORTED_MAX_LEASE_TIME: Max lease time should be between 300 and 2^32-1 seconds respectively., value = 300L) Max(error = DHCPSERVER_CONFIG_UNSUPPORTED_MAX_LEASE_TIME: Max lease time should be between 300 and 2^32-1 seconds respectively., value = 4294967295L) ", "format": "int64" }, "default_lease_time": { "type": "integer", "description": "Default Lease Time: Min(error = DHCPSERVER_CONFIG_UNSUPPORTED_DEFAULT_LEASE_TIME: Default lease time should be between 300 and 2^32-1 seconds respectively., value = 300L) Max(error = DHCPSERVER_CONFIG_UNSUPPORTED_DEFAULT_LEASE_TIME: Default lease time should be between 300 and 2^32-1 seconds respectively., value = 4294967295L) ", "format": "int64" }, "dns_servers": { "type": "array", "description": "Dns Servers: Size(max = 3, error = DHCPSERVER_CONFIG_DNS_ENTRIES_EXCEEDS_LIMIT: Name servers count exceeds the maximum limit, min = 0) ", "items": { "type": "string", "description": "Dns Servers" } }, "domain_name": { "type": "string", "description": "Domain Name: Size(max = 256, error = DHCPSERVER_CONFIG_INVALID_DOMAIN_NAME: Domain name exceeds the maximum limit., min = 0) " }, "broadcast_address": { "type": "string", "description": "Broadcast Address" }, "gateway": { "type": "string", "description": "Gateway" }, "subnet": { "type": "string", "description": "Subnet: NotNull(error = DHCPSERVER_CONFIG_INVALID_SUBNET_ADDR: Invalid IPv4 subnet address.) " }, "network_context_id": { "type": "string", "description": "Network Context Id: Digits(fraction = 0, integer = 50, error = INVALID_NETWORK_CTX_ID: Invalid network ctrx id.) " }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DHCPSERVER_CONFIG_DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds the maximum limit., min = 0) " }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 128, listMaxSize = 10, error = DHCPSERVER_CONFIG_INVALID_TAGS: Tags config is invalid- maximum 10 tags are supported, tag should not exceed maximum limit of 128 characters, it should not have duplicates., noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "disabled": { "type": "boolean", "description": "Disabled" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "ip_ranges", "subnet" ] }, "CellularModuleStateV2N1": { "properties": { "firmware": { "type": "array", "description": "Firmware", "items": { "$ref": "#/components/schemas/FirmwareState" } }, "cellular_module_id": { "type": "string", "description": "Cellular Module Id" }, "element_id": { "type": "string", "description": "Element Id" }, "gps": { "description": "Gps", "$ref": "#/components/schemas/GPSState" }, "sim": { "type": "array", "description": "Sim", "items": { "$ref": "#/components/schemas/SimState" } }, "network_state": { "description": "Network State", "$ref": "#/components/schemas/NetworkState" }, "active_sim": { "type": "integer", "description": "Active Sim" }, "activation_state": { "type": "string", "description": "Activation State" }, "packet_service_state": { "type": "string", "description": "Packet Service State" }, "network_registration_state": { "type": "string", "description": "Network Registration State" }, "signal_strength_indicator": { "type": "string", "description": "Signal Strength Indicator" }, "technology": { "type": "string", "description": "Technology" }, "carrier": { "type": "string", "description": "Carrier" }, "modem_error_reason": { "type": "string", "description": "Modem Error Reason" }, "modem_state": { "type": "string", "description": "Modem State" }, "last_state_change": { "type": "integer", "description": "Last State Change", "format": "int64" }, "serial_number": { "type": "string", "description": "Serial Number" }, "imei": { "type": "string", "description": "Imei" }, "manufacturer": { "type": "string", "description": "Manufacturer" }, "model_name": { "type": "string", "description": "Model Name" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "Ipv6Config": { "properties": { "routes": { "type": "array", "description": "Routes", "items": { "$ref": "#/components/schemas/Route" } }, "dns_v6_config": { "description": "Dns V6 Config: Valid ", "$ref": "#/components/schemas/DNS" }, "dhcp_config": { "description": "Dhcp Config", "$ref": "#/components/schemas/Ipv6Dhcp" }, "static_config": { "description": "Static Config", "$ref": "#/components/schemas/Ipv6Static" }, "type": { "type": "string", "description": "Type" } } }, "LocalPrefixFilterScreen": { "properties": { "description": { "type": "string", "description": "Description: Size(max = 256, error = PREFIXFILTER_INVALID_DESCRIPTION: Prefix filter description exceeds limit., min = 0) " }, "name": { "type": "string", "description": "Name: Size(max = 128, error = PREFIXFILTER_INVALID_NAME: Prefix filter name exceeds limit., min = 1) Required(error = PREFIXFILTER_NAME_REQUIRED: Prefix filter name required.) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "MulticastPeerGroupV2N1": { "properties": { "is_source_site_receiver": { "type": "boolean", "description": "Is Source Site Receiver" }, "peer_sites": { "type": "array", "description": "Peer Sites: Valid ListObject(allowDuplicate = true, allowEmpty = false, allowNull = false, listMaxSize = 0, message = MULTICAST_INVALID_PEER_SITE, required = false) ", "items": { "$ref": "#/components/schemas/MulticastPeerSite" } }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "peer_sites", "name" ] }, "RoutingRouteMap": { "properties": { "auto_generated": { "type": "boolean", "description": "Auto Generated" }, "route_map_entries": { "type": "array", "description": "Route Map Entries: Valid Valid ", "items": { "$ref": "#/components/schemas/RoutingRouteMapEntry" } }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 1024, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "SwitchState": { "properties": { "max_hops": { "type": "integer", "description": "Max Hops", "format": "int32" }, "root_port": { "type": "string", "description": "Root Port" }, "designated_bridge_id": { "type": "string", "description": "Designated Bridge Id" }, "root_path_cost": { "type": "integer", "description": "Root Path Cost", "format": "int32" }, "root_bridge_id": { "type": "string", "description": "Root Bridge Id" }, "bridge_id": { "type": "string", "description": "Bridge Id" }, "last_topology_change": { "type": "string", "description": "Last Topology Change" }, "stp_priority": { "type": "integer", "description": "Stp Priority", "format": "int32" }, "stp_forward_delay": { "type": "integer", "description": "Stp Forward Delay", "format": "int32" }, "stp_hello_time": { "type": "integer", "description": "Stp Hello Time", "format": "int32" }, "stp_aging_timer": { "type": "integer", "description": "Stp Aging Timer", "format": "int32" }, "stp_max_age": { "type": "integer", "description": "Stp Max Age", "format": "int32" }, "stp_mode": { "type": "string", "description": "Stp Mode" }, "default_vlan_id": { "type": "integer", "description": "Default Vlan Id", "format": "int32" }, "mstp_enabled": { "type": "boolean", "description": "Mstp Enabled" } } }, "ElementSystemLimitProfileQuery": { "properties": { "isReadPreferenceSecondary": { "type": "boolean", "description": "IsReadPreferenceSecondary: JsonIgnore(value = true) " }, "last_query_ts": { "type": "integer", "description": "Last Query Ts", "format": "int64" }, "getDeleted": { "type": "boolean", "description": "GetDeleted" }, "aggregate": { "description": "Aggregate", "$ref": "#/components/schemas/Aggregate" }, "group_by": { "type": "array", "description": "Group By", "items": { "type": "string", "description": "Group By" } }, "retrieved_fields": { "type": "array", "description": "Retrieved Fields", "items": { "type": "string", "description": "Retrieved Fields" } }, "retrieved_fields_mask": { "type": "boolean", "description": "Retrieved Fields Mask" }, "total_count": { "type": "integer", "description": "Total Count", "format": "int64" }, "dest_page": { "type": "integer", "description": "Dest Page", "format": "int32" }, "next_query": { "type": "object" }, "limit": { "type": "integer", "description": "Limit", "format": "int32" }, "sort_case_insensitive": { "type": "boolean", "description": "Sort Case Insensitive" }, "sort_params": { "type": "object" }, "query_params": { "type": "object" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "ServiceEndpointV3": { "properties": { "sase_properties": { "description": "Sase Properties: Valid ", "$ref": "#/components/schemas/SaseServiceEndpointProperties" }, "is_sase": { "type": "boolean", "description": "Is Sase" }, "disable_tunnel_reoptimization": { "type": "boolean", "description": "Disable Tunnel Reoptimization" }, "liveliness_probe": { "description": "Liveliness Probe: Valid ", "$ref": "#/components/schemas/SEPLivelinessProbeV2N2" }, "location": { "description": "Location: Valid ", "$ref": "#/components/schemas/Location" }, "address": { "description": "Address: Valid ", "$ref": "#/components/schemas/Address" }, "allow_enterprise_traffic": { "type": "boolean", "description": "Allow Enterprise Traffic" }, "service_link_peers": { "description": "Service Link Peers: Valid ", "$ref": "#/components/schemas/ServiceLinkPeers" }, "site_id": { "type": "string", "description": "Site Id" }, "admin_up": { "type": "boolean", "description": "Admin Up: Required(error = ADMIN_UP_REQD: Admin up required.) " }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[NetworkServiceType], message = Invalid enum string., nullAllowed = false) ", "enum": [ "CG_TRANSIT", "NON_CG_TRANSIT", "SASE" ] }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_SIZE_EXCEEDED: Description size exceeded., min = 0) Valid " }, "name": { "type": "string", "description": "Name: Required(error = SERVICEENDPOINT_NAME_REQD: service endpoint name required.) Size(max = 128, error = SERVICEENDPOINT_NAME_EXCEEDS_LIMIT: Service endpoint name exceeds limit., min = 0) Valid " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "admin_up", "type", "name" ] }, "ElementCopyConfigurationsScreen": { "properties": { "interface_configurations": { "type": "array", "description": "Interface Configurations", "items": { "$ref": "#/components/schemas/ElementShellInterfaceScreen" } }, "element_configurations": { "description": "Element Configurations: JsonIgnoreProperties(allowGetters = false, allowSetters = false, ignoreUnknown = true) ", "$ref": "#/components/schemas/ElementShellScreen" }, "source_element_id": { "type": "string", "description": "Source Element Id: Required(ELEMENT_ID_REQUIRED) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "source_element_id" ] }, "SnapshotExportQueryFilter": { "properties": { "snapshot_name": { "type": "string", "description": "Snapshot Name" }, "yaml_configuration": { "type": "string", "description": "Yaml Configuration" }, "status_description": { "type": "string", "description": "Status Description" }, "status": { "type": "string", "description": "Status" }, "site_id": { "type": "string", "description": "Site Id" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "SecurityPolicyV2N2RuleScreen": { "properties": { "dest_device_ids": { "type": "array", "description": "Dest Device Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, DUPLICATE_DEST_DEVICE_IDS, noTrim = false, regex = , required = false) Size(max = 10, DEST_DEVICE_ID_LIST_SIZE_EXCEEDED, min = 0) ", "items": { "type": "string", "description": "Dest Device Ids" } }, "src_device_ids": { "type": "array", "description": "Src Device Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, DUPLICATE_SRC_DEVICE_IDS, noTrim = false, regex = , required = false) Size(max = 256, SRC_DEVICE_ID_LIST_SIZE_EXCEEDED, min = 0) ", "items": { "type": "string", "description": "Src Device Ids" } }, "user_or_group": { "description": "User Or Group: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = NON_NULL, valueFilter = classOf[Void]) Valid ", "$ref": "#/components/schemas/UserGroup" }, "services": { "type": "array", "description": "Services", "items": { "$ref": "#/components/schemas/Service" } }, "enabled": { "type": "boolean", "description": "Enabled: NotNull " }, "action": { "type": "string", "description": "Action: ValidateEnum(enumClass = classOf[SecurityAction], message = SECURITY_POLICYRULE_INVALID_ACTION, nullAllowed = false) " }, "destination_zone_ids": { "type": "array", "description": "Destination Zone Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, error = DUPLICATE_DESTINATION_ZONE_IDS: Duplicate destination zone IDs found., noTrim = false, regex = , required = false) Size(max = 16, error = DESTINATION_ZONE_ID_LIST_SIZE_EXCEEDED: Too many destination zone IDs. Max = 16., min = 0) ", "items": { "type": "string", "description": "Destination Zone Ids" } }, "destination_prefix_ids": { "type": "array", "description": "Destination Prefix Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, error = DUPLICATE_DESTINATION_PREFIX_IDS: Duplicate destination prefix IDs found., noTrim = false, regex = , required = false) Size(max = 16, error = DESTINATION_PREFIX_ID_LIST_SIZE_EXCEEDED: Too many destination prefix IDs. Max = 16., min = 0) ", "items": { "type": "string", "description": "Destination Prefix Ids" } }, "source_prefix_ids": { "type": "array", "description": "Source Prefix Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, error = DUPLICATE_SOURCE_PREFIX_IDS: Duplicate source prefix IDs found., noTrim = false, regex = , required = false) Size(max = 16, error = SOURCE_PREFIX_ID_LIST_SIZE_EXCEEDED: Too many source prefix IDs. Max = 16., min = 0) ", "items": { "type": "string", "description": "Source Prefix Ids" } }, "source_zone_ids": { "type": "array", "description": "Source Zone Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, error = DUPLICATE_SOURCE_ZONE_IDS: Duplicate source zone IDs found., noTrim = false, regex = , required = false) Size(max = 16, error = SOURCE_ZONE_ID_LIST_SIZE_EXCEEDED: Too many source zone IDs. Max = 16., min = 0) ", "items": { "type": "string", "description": "Source Zone Ids" } }, "app_def_ids": { "type": "array", "description": "App Def Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, error = DUPLICATE_APP_DEF_IDS: Duplicate app ids are specified., noTrim = false, regex = , required = false) Size(max = 256, error = APP_DEF_ID_LIST_SIZE_EXCEEDED: Maximum 256 applications can be specified in a rule., min = 0) ", "items": { "type": "string", "description": "App Def Ids" } }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "enabled", "action", "name" ] }, "ElementSoftwareState": { "properties": { "interface_ids": { "type": "array", "description": "Interface Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 4, message = {SOFTWARE_CONFIG_INVALID_INTERFACE_LIST, noTrim = false, regex = , required = false) ", "items": { "type": "string", "description": "Interface Ids" } }, "upgrade_interval": { "type": "integer", "description": "Upgrade Interval: Range(max = 59L, error = SOFTWARE_CONFIG_INVALID_UPGRADE_INTERVAL: Valid upgrade interval shoule be provided along with a valid upgrade time., min = 0L) " }, "scheduled_upgrade": { "type": "string", "description": "Scheduled Upgrade: Pattern(message = ELEMENT_STATE_UPDATE_INVALID_TIME, regexp = ^(0?[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])-(201?[8-9]|20?[2-5][0-9])\\\\s+([0-1][0-9]|2?[0-3])\\\\:([0-5][0-9])\\\\:([0-5][0-9])$) " }, "download_interval": { "type": "integer", "description": "Download Interval: Range(max = 59L, error = SOFTWARE_CONFIG_INVALID_DOWNLOAD_INTERVAL: Valid download interval shoule be provided along with a valid download time., min = 0L) " }, "scheduled_download": { "type": "string", "description": "Scheduled Download: Pattern(message = ELEMENT_STATE_UPDATE_INVALID_TIME, regexp = ^(0?[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])-(201?[8-9]|20?[2-5][0-9])\\\\s+([0-1][0-9]|2?[0-3])\\\\:([0-5][0-9])\\\\:([0-5][0-9])$) " }, "image_id": { "type": "string", "description": "Image Id: Pattern(message = ELEMENT_STATE_UPDATE_INVALID_IMAGE, regexp = ^[0-9]{1,30}$) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "ElementShellInterfaceScreen": { "properties": { "interface_configuration": { "description": "Interface Configuration: JsonIgnoreProperties(allowGetters = false, allowSetters = false, ignoreUnknown = true) ", "$ref": "#/components/schemas/InterfaceScreenV4N17" }, "element_shell_interface_id": { "type": "string", "description": "Element Shell Interface Id" }, "element_interface_id": { "type": "string", "description": "Element Interface Id" }, "operation": { "type": "string", "description": "Operation", "enum": [ "CREATE", "UPDATE", "DELETE" ] } } }, "IKEV1Params": { "properties": { "xauth_secret_encrypted": { "type": "string", "description": "Xauth Secret Encrypted: JsonIgnore(value = true) " }, "xauth_secret_hash": { "type": "string", "description": "Xauth Secret Hash: JsonIgnore(value = true) " }, "xauth_secret": { "type": "string", "description": "Xauth Secret: Length(max = 128, error = IPSECCONFIG_INVALID_XAUTH_SECRET_LEN: Invalid extended authentication secret length.Should be between 4-128., min = 4) " }, "xauth_id": { "type": "string", "description": "Xauth Id" }, "xauth_type": { "type": "string", "description": "Xauth Type: ValidateEnum(enumClass = classOf[IKEXAuthType], error = IPSECCONFIG_INVALID_XAUTH_TYPE: Invalid extended authentication type specified.Valid type are secret or none., nullAllowed = false) ", "enum": [ "NONE", "SECRET" ] } }, "required": [ "xauth_type" ] }, "VRFContextProfile": { "properties": { "vrf_context_route_leak_rules": { "type": "array", "description": "Vrf Context Route Leak Rules: Valid ", "items": { "$ref": "#/components/schemas/VRFContextRouteLeakRule" } }, "vrf_context_ids": { "type": "array", "description": "Vrf Context Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, INVALID_STRING, noTrim = false, regex = , required = false) ", "items": { "type": "string", "description": "Vrf Context Ids" } }, "default_vrf_context_profile": { "type": "boolean", "description": "Default Vrf Context Profile" }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = VRF_CONTEXT_PROFILE_DESCRIPTION_INVALID: Vrf profile description exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: NotBlank(error = VRF_CONTEXT_PROFILE_NAME_INVALID: Vrf context profile name is invalid) Size(max = 128, error = VRF_CONTEXT_PROFILE_NAME_EXCEEDS_LIMIT: Vrf context profile name exceeds limit, min = 0) Pattern(error = VRF_CONTEXT_PROFILE_NAME_INVALID: Vrf context profile name is invalid, regexp = ^[A-Za-z][A-Za-z0-9_\\\\s-]*$) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "EventCorrelationPolicyRuleQueryFilter": { "properties": { "policyset_id": { "type": "string", "description": "Policyset Id: Digits(fraction = 0, integer = 30, INVALID_POLICYSET_ID) " }, "escalation_rules": { "description": "Escalation Rules: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void]) Valid ", "$ref": "#/components/schemas/EscalationRule" }, "enabled": { "type": "boolean", "description": "Enabled" }, "priority": { "type": "string", "description": "Priority: ValidateEnum(enumClass = classOf[EventPriority], error = EVENT_POLICY_INVALID_PRIORITY: Invalid priority is specified for event policy, nullAllowed = false) ", "enum": [ "p1", "p2", "p3", "p4", "p5", "none" ] }, "suppress": { "type": "string", "description": "Suppress: ValidateEnum(enumClass = classOf[Suppress], error = EVENT_POLICY_INVALID_SUPPRESS: Invalid suppress value is specified for event policy, nullAllowed = false) ", "enum": [ "yes", "no", "none" ] }, "event_codes": { "type": "array", "description": "Event Codes", "items": { "type": "string", "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", "DEVICE_CELLULAR_MODEM_GPS_DC_BIOS_FAULT", "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", "CUID_SYNC_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", "DEVICESW_MFGCERT_RENEWAL_FAILED", "DEVICESW_MFGCERT_EXPIRY_WARNING", "DEVICEHW_POWER_MISSING", "SYSTEM_CIRCUIT_UTILIZATION_THRESHOLD_EXCEEDED", "SYSTEM_CPU_THRESHOLD_EXCEEDED", "SYSTEM_MEMORY_THRESHOLD_EXCEEDED", "SYSTEM_DISK_THRESHOLD_EXCEEDED", "SYSTEM_CONCURRENT_FLOW_THRESHOLD_EXCEEDED", "DEVICESW_MCTD_INITIALIZATION_FAILURE", "DEVICESW_MCTD_CONTENT_LOAD_FAILURE", "DEVICESW_MCTD_LOG_BUFFER_FULL", "DEVICESW_URLCLOUDSERVER_DOWN", "DEVICESW_DNSSECCLOUDSERVER_DOWN", "DEVICESW_SLSCONNECTION_DOWN", "ALL_INCIDENTS", "ALL_ALERTS", "DEVICESW_TACACS_SERVERS_DOWN", "BRANCH_GATEWAY_CLUSTER_SITE_COUNT_THRESHOLD_EXCEEDED", "FLOW_LIMIT_PER_SOURCE_EXCEEDED", "SECURITY_POLICY_RULES_FAILED", "NPNSPN_INSUFFICIENT_VALID_GENEVE_KEYS", "INCONSISTENT_IPSEC_TUNNEL_HA_STATE", "NPN_MP_CPU_HIGH" ] } }, "end_time": { "type": "integer", "description": "End Time", "format": "int64" }, "start_time": { "type": "integer", "description": "Start Time", "format": "int64" }, "resource_ids": { "type": "array", "description": "Resource Ids: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 0, error = EVENT_POLICY_INVALID_RESOURCES: Invalid resource(s) is specified for event policy, noTrim = false, regex = [0-9]{1,30}, required = false) Size(max = 2000, error = EVENT_POLICY_RULE_MAX_RESOURCE_IDS: Maximum 128 resources can be configured in a rule, min = 0) ", "items": { "type": "string", "description": "Resource Ids" } }, "sub_resource_type": { "type": "string", "description": "Sub Resource Type: ValidateEnum(enumClass = classOf[SubResourceType], error = EVENT_POLICY_INVALID_RESOURCE_SUB_TYPE: Invalid sub resource type is specified for event policy, nullAllowed = true) ", "enum": [ "spoke", "hub", "public", "private" ] }, "resource_type": { "type": "string", "description": "Resource Type: ValidateEnum(enumClass = classOf[ResourceType], error = EVENT_POLICY_INVALID_RESOURCE_TYPE: Invalid resource type is specified for event policy, nullAllowed = true) ", "enum": [ "site", "element", "anynetlink", "bgppeer", "interface", "waninterface", "wannetwork", "networkpolicyset", "prioritypolicyset", "natpolicyset", "securitypolicyset", "appdef", "serviceendpoint", "cellular_module", "hubcluster", "useridagent", "directoryservice", "cuid", "deviceidconfig", "machine", "spokecluster", "user_id" ] }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "priority", "suppress", "name" ] }, "ServiceLabelV2N1": { "properties": { "sase_properties": { "description": "Sase Properties: Valid ", "$ref": "#/components/schemas/SaseServiceLabelProperties" }, "type": { "type": "string", "description": "Type: ValidateEnum(enumClass = classOf[NetworkServiceType], message = Invalid enum string., nullAllowed = false) ", "enum": [ "CG_TRANSIT", "NON_CG_TRANSIT", "SASE" ] }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_SIZE_EXCEEDED: Description size exceeded., min = 0) Valid " }, "name": { "type": "string", "description": "Name: Required(error = SERVICELABEL_NAME_REQD: Service label name required.) Size(max = 128, error = SERVICELABEL_NAME_EXCEEDS_LIMIT: Service label name exceeds limit., min = 0) Valid " }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "type", "name" ] }, "LanNetworkIPv6Config": { "properties": { "prefixes": { "type": "array", "description": "Prefixes: ListIPv6Address(bcast = DENY, listMaxSize = 0, message = LAN_CONFIG_INVALID_PREFIX_V6, required = false, type = GATEWAYCIDRV6) ", "items": { "type": "string", "description": "Prefixes" } }, "default_routers": { "type": "array", "description": "Default Routers: ListIPv6Address(bcast = DENY, listMaxSize = 0, message = LAN_CONFIG_V6_INVALID_DEFAULT_ROUTERS, required = false, type = IPCIDR_128) ", "items": { "type": "string", "description": "Default Routers" } } } }, "WanOverlay": { "properties": { "vni": { "type": "integer", "description": "Vni: Required(error = VNI_REQD: VNI is a mandatory property.) Range(max = 64511L, error = INVALID_VNI_VALUE: VNI is invalid. It should be between 0 to 64511., min = 0L) ", "format": "int32" }, "description": { "type": "string", "description": "Description: Size(max = 256, error = WANOVERLAY_CONFIG_DESCRIPTION_INVALID: Wan overlay config description invalid., min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = WANOVERLAY_CONFIG_NAME_REQD: WAN Overlay name required.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "vni", "name" ] }, "VlanConfig": { "properties": { "mstp_instance": { "type": "integer", "description": "Mstp Instance", "format": "int32" }, "vlan_id": { "type": "integer", "description": "Vlan Id", "format": "int32" }, "voice_enabled": { "type": "boolean", "description": "Voice Enabled" } } }, "PerfMgmtPolicyRuleQuery": { "properties": { "isReadPreferenceSecondary": { "type": "boolean", "description": "IsReadPreferenceSecondary: JsonIgnore(value = true) " }, "last_query_ts": { "type": "integer", "description": "Last Query Ts", "format": "int64" }, "getDeleted": { "type": "boolean", "description": "GetDeleted" }, "aggregate": { "description": "Aggregate", "$ref": "#/components/schemas/Aggregate" }, "group_by": { "type": "array", "description": "Group By", "items": { "type": "string", "description": "Group By" } }, "retrieved_fields": { "type": "array", "description": "Retrieved Fields", "items": { "type": "string", "description": "Retrieved Fields" } }, "retrieved_fields_mask": { "type": "boolean", "description": "Retrieved Fields Mask" }, "total_count": { "type": "integer", "description": "Total Count", "format": "int64" }, "dest_page": { "type": "integer", "description": "Dest Page", "format": "int32" }, "next_query": { "type": "object" }, "limit": { "type": "integer", "description": "Limit", "format": "int32" }, "sort_case_insensitive": { "type": "boolean", "description": "Sort Case Insensitive" }, "sort_params": { "type": "object" }, "query_params": { "type": "object" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } } }, "BGPPeerQueryFilter": { "properties": { "bgp_config": { "description": "Bgp Config: Valid ", "$ref": "#/components/schemas/BGPConfig" }, "update_source": { "type": "string", "description": "Update Source: IPAddress(allowEmpty = false, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, PEER_CONFIG_INVALID_UPDATE_SOURCE_IP, type = IP) " }, "route_map_out_id": { "type": "string", "description": "Route Map Out Id" }, "route_map_in_id": { "type": "string", "description": "Route Map In Id" }, "peer_type": { "type": "string", "description": "Peer Type" }, "remote_as_num": { "type": "string", "description": "Remote As Num: NotEmpty(REQUIRED_REMOTE_AS_NUM) " }, "peer_ip": { "type": "string", "description": "Peer Ip: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, error = PEER_CONFIG_INVALID_PEER_IP: Invalid IP address for routing peer. Please use a valid IPv4 address., type = IP) " }, "tags": { "type": "array", "description": "Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\\\\s]+, required = false) ", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 1024, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "remote_as_num", "name" ] }, "DirectoryUserGroup": { "properties": { "stale": { "type": "boolean", "description": "Stale" }, "tags": { "type": "array", "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": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0) " }, "name": { "type": "string", "description": "Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0) " }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string", "description": "Id" } }, "required": [ "name" ] }, "ElementNTPState": { "properties": { "source_interface_ids": { "type": "array", "description": "Source Interface Ids", "items": { "type": "string", "description": "Source Interface Ids" } }, "ntp_id": { "type": "string", "description": "Ntp Id: JsonIgnore(value = true) JsonIgnore(value = true) " }, "ntp_hash": { "type": "integer", "description": "Ntp Hash: JsonIgnore(value = true) JsonIgnore(value = true) ", "format": "int32" }, "element_id": { "type": "string", "description": "Element Id" }, "ntp_servers": { "type": "array", "description": "Ntp Servers", "items": { "$ref": "#/components/schemas/NTPServerState" } }, "cts": { "description": "Cts", "$ref": "#/components/schemas/NTPServerState" }, "tags": { "type": "array", "description": "Tags", "items": { "type": "string", "description": "Tags" } }, "description": { "type": "string", "description": "Description" }, "name": { "type": "string", "description": "Name" }, "region": { "type": "string", "description": "Region" }, "disabled_reason": { "type": "string", "description": "Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0) " }, "disabled": { "type": "boolean", "description": "Disabled" }, "inactive_reason": { "type": "string", "description": "Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0) " }, "inactive": { "type": "boolean", "description": "Inactive" }, "_etag": { "type": "integer", "description": "Object version. Required for PUT requests, ignored for POST.", "format": "int64" }, "id": { "type": "string" } } }, "AppDefV2": { "properties": { "category": { "type": "string", "description": "Category: ValidateEnum(enumClass = classOf[AppCategory], error = APPDEF_CONFIG_INVALID_CATEGORY: Application category is invalid., nullAllowed = false) ", "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" ] }, "app_type": { "type": "string", "description": "App Type", "enum": [ "custom" ] }, "transfer_type": { "type": "string", "description": "Transfer Type", "enum": [ "transactional", "bulk", "rt-audio", "rt-video" ] }, "udp_rules": { "type": "array", "description": "Udp 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": { "$ref": "#/components/schemas/UdpRule" } }, "tcp_rules": { "type": "array", "description": "Tcp 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": { "$ref": "#/components/schemas/TcpRule" } }, "domains": { "type": "array", "description": "Domains: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 256, listMaxSize = 16, error = APPDEF_CONFIG_INVALID_DOMAIN_LIST: Application domain list is invalid. Maximum 16 valid domains are allowed and each domain should not exceed 253 characters., noTrim = false, regex = (?=^.{4,253}$)((^((?!-)[a-zA-Z0-9-]{1,63}(?