diff --git a/openapi-specs/scm/config/sase/deployment/deployment-services-updated.yaml b/openapi-specs/scm/config/sase/deployment/deployment-services-latest.yaml similarity index 99% rename from openapi-specs/scm/config/sase/deployment/deployment-services-updated.yaml rename to openapi-specs/scm/config/sase/deployment/deployment-services-latest.yaml index ccae668b0..ed0b136f8 100644 --- a/openapi-specs/scm/config/sase/deployment/deployment-services-updated.yaml +++ b/openapi-specs/scm/config/sase/deployment/deployment-services-latest.yaml @@ -1940,10 +1940,6 @@ components: name: type: string description: The name of the service connection - folder: - type: string - description: The folder containing the service connection - default: Service Connections ipsec_tunnel: type: string onboarding_type: @@ -2019,7 +2015,6 @@ components: required: - id - name - - folder - ipsec_tunnel - region service-connection-groups: @@ -2033,10 +2028,6 @@ components: example: 123e4567-e89b-12d3-a456-426655440000 name: type: string - folder: - type: string - description: The folder containing the service connection group - default: Service Connections disable_snat: type: boolean pbf_only: @@ -2048,7 +2039,6 @@ components: required: - id - name - - folder - target shared-infrastructure-settings: type: object diff --git a/openapi-specs/scm/config/sase/identity/identity-services.yaml b/openapi-specs/scm/config/sase/identity/identity-services-latest.yaml similarity index 96% rename from openapi-specs/scm/config/sase/identity/identity-services.yaml rename to openapi-specs/scm/config/sase/identity/identity-services-latest.yaml index 26f5fdb5f..ff63a3e96 100644 --- a/openapi-specs/scm/config/sase/identity/identity-services.yaml +++ b/openapi-specs/scm/config/sase/identity/identity-services-latest.yaml @@ -2898,7 +2898,7 @@ components: Tenant Service Group (TSG) ID. The resulting JWT access token should be attached to all API calls as a `Bearer` token in the `Authorization` header (ex. `Authorization: Bearer tokenstring`). - flows: + flows: clientCredentials: tokenUrl: https://auth.apps.paloaltonetworks.com/oauth2/access_token scopes: {} @@ -3283,7 +3283,7 @@ components: schemas: authentication-rules: type: object - required: + required: - id - name - from @@ -3425,7 +3425,7 @@ components: - rulebase authentication-portals: type: object - required: + required: - id - redirect_host properties: @@ -3466,34 +3466,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device authentication-profiles: type: object required: @@ -3642,37 +3642,37 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device local-users: type: object - required: + required: - id - name - password @@ -3701,37 +3701,37 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device local-user-groups: type: object - required: + required: - id - name properties: @@ -3756,34 +3756,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device saml-server-profiles: type: object required: @@ -3843,34 +3843,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device ldap-server-profiles: type: object required: @@ -3944,34 +3944,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device radius-server-profiles: type: object required: @@ -4072,34 +4072,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device tacacs-server-profiles: type: object required: @@ -4157,37 +4157,37 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device kerberos-server-profiles: type: object - required: + required: - id - name - server @@ -4223,34 +4223,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device authentication-sequences: type: object required: @@ -4280,34 +4280,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device mfa-servers: type: object required: @@ -4334,7 +4334,7 @@ components: properties: okta_adaptive_v1: type: object - required: + required: - okta_api_host - okta_baseuri - okta_token @@ -4364,8 +4364,7 @@ components: type: string minLength: 2 default: /api/v1 - description: - Integration with [Okta Adaptive MFA](https://www.okta.com/products/adaptive-multi-factor-authentication) + description: Integration with [Okta Adaptive MFA](https://www.okta.com/products/adaptive-multi-factor-authentication) - type: object title: ping_identity_v1 properties: @@ -4409,8 +4408,7 @@ components: maximum: 600 default: 30 description: Ping Identity timeout (seconds) - description: - Integation with [Ping Identity](https://www.pingidentity.com/en/platform.html) + description: Integation with [Ping Identity](https://www.pingidentity.com/en/platform.html) - type: object title: rsa_securid_access_v1 properties: @@ -4439,21 +4437,20 @@ components: rsa_assurancepolicyid: type: string minLength: 3 - description: RSA SecurID assurance level + description: RSA SecurID assurance level rsa_timeout: type: integer minimum: 5 maximum: 600 default: 30 description: RSA SecurID timeout (seconds) - description: - Integration with [RSA SecurID](https://www.rsa.com/products/securid/) + description: Integration with [RSA SecurID](https://www.rsa.com/products/securid/) - type: object title: duo_security_v2 properties: duo_security_v2: type: object - required: + required: - duo_api_host - duo_integration_key - duo_secret_key @@ -4494,34 +4491,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device certificates-get: type: object properties: @@ -4578,37 +4575,37 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device certificates-post: type: object - required: + required: - id - name - common_name @@ -4644,7 +4641,7 @@ components: - 4096 required: - ecdsa_number_of_bits - description: Encryption algorithm + description: Encryption algorithm alternate_email: type: array items: @@ -4725,34 +4722,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device certificates-import: type: object required: @@ -4776,7 +4773,7 @@ components: description: Certificate format key_file: type: string - description: The Base64 encoded content of the certificate private key + description: The Base64 encoded content of the certificate private key passphrase: type: string format: password @@ -4787,34 +4784,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device certificate-profiles: type: object required: @@ -4849,8 +4846,8 @@ components: type: array items: type: object - required: - - name + required: + - name properties: name: type: string @@ -4883,54 +4880,50 @@ components: description: Use OCSP? block_unknown_cert: type: boolean - description: - Block session if certificate status is unknown? + description: Block session if certificate status is unknown? block_timeout_cert: type: boolean - description: - Block session if certificate status cannot be retrieved within timeout? + description: Block session if certificate status cannot be retrieved within timeout? block_unauthenticated_cert: type: boolean - description: - Block session if the certificate was not issued to the authenticating device? + description: Block session if the certificate was not issued to the authenticating device? block_expired_cert: type: boolean - description: - Block sessions with expired certificates? + description: Block sessions with expired certificates? oneOf: - type: object title: folder properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device scep-profiles: type: object required: @@ -5068,34 +5061,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device trusted-certificate-authorities: type: object properties: @@ -5215,34 +5208,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device ocsp-responders: type: object required: @@ -5271,34 +5264,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device export-certificate-payload: type: object properties: diff --git a/openapi-specs/scm/config/sase/mobileagent/mobile-agent.yaml b/openapi-specs/scm/config/sase/mobileagent/mobile-agent-latest.yaml similarity index 100% rename from openapi-specs/scm/config/sase/mobileagent/mobile-agent.yaml rename to openapi-specs/scm/config/sase/mobileagent/mobile-agent-latest.yaml diff --git a/openapi-specs/scm/config/sase/network/network-services.yaml b/openapi-specs/scm/config/sase/network/network-services-latest.yaml similarity index 73% rename from openapi-specs/scm/config/sase/network/network-services.yaml rename to openapi-specs/scm/config/sase/network/network-services-latest.yaml index 1d62384f4..784fc5f29 100644 --- a/openapi-specs/scm/config/sase/network/network-services.yaml +++ b/openapi-specs/scm/config/sase/network/network-services-latest.yaml @@ -5294,7 +5294,7 @@ paths: '409': $ref: '#/components/responses/conflict_errors' default: - $ref: '#/components/responses/default_errors' + $ref: '#/components/responses/default_errors' /auto-vpn-monitor: get: tags: @@ -5356,7 +5356,7 @@ paths: '409': $ref: '#/components/responses/conflict_errors' default: - $ref: '#/components/responses/default_errors' + $ref: '#/components/responses/default_errors' /auto-vpn-settings: get: tags: @@ -6773,7 +6773,7 @@ components: Tenant Service Group (TSG) ID. The resulting JWT access token should be attached to all API calls as a `Bearer` token in the `Authorization` header (ex. `Authorization: Bearer tokenstring`). - flows: + flows: clientCredentials: tokenUrl: https://auth.apps.paloaltonetworks.com/oauth2/access_token scopes: @@ -7206,6 +7206,7 @@ components: default: group2 lifetime: type: object + description: Ike crypto profile lifetime oneOf: - type: object title: seconds @@ -7255,35 +7256,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: + required: - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: + required: - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: + required: - device - ike-gateways: type: object properties: @@ -7442,35 +7442,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: + required: - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: + required: - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: + required: - device - ipsec-crypto-profiles: type: object properties: @@ -7496,6 +7495,7 @@ components: default: group2 lifetime: type: object + description: Ipsec crypto profile lifetime oneOf: - type: object title: seconds @@ -7569,91 +7569,90 @@ components: - lifetime anyOf: - oneOf: - - type: object - title: esp - properties: - esp: - type: object - properties: - encryption: - type: array - description: Encryption algorithm - items: - enum: - - des - - 3des - - aes-128-cbc - - aes-192-cbc - - aes-256-cbc - - aes-128-gcm - - aes-256-gcm - - 'null' - default: aes-128-cbc - authentication: - type: array - description: Authentication algorithm - items: - type: string - default: sha1 - required: - - encryption - - authentication - required: - - esp - - type: object - title: ah - properties: - ah: - type: object - properties: - authentication: - type: array - items: - enum: - - md5 - - sha1 - - sha256 - - sha384 - - sha512 - required: - - authentication - required: - - ah + - type: object + title: esp + properties: + esp: + type: object + properties: + encryption: + type: array + description: Encryption algorithm + items: + enum: + - des + - 3des + - aes-128-cbc + - aes-192-cbc + - aes-256-cbc + - aes-128-gcm + - aes-256-gcm + - 'null' + default: aes-128-cbc + authentication: + type: array + description: Authentication algorithm + items: + type: string + default: sha1 + required: + - encryption + - authentication + required: + - esp + - type: object + title: ah + properties: + ah: + type: object + properties: + authentication: + type: array + items: + enum: + - md5 + - sha1 + - sha256 + - sha384 + - sha512 + required: + - authentication + required: + - ah - oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device ipsec-tunnels: type: object properties: @@ -7687,6 +7686,7 @@ components: description: IPv4 type of proxy_id values items: type: object + description: IPv4 type of proxy_id values for TCP protocol properties: name: type: string @@ -7696,6 +7696,7 @@ components: type: string protocol: type: object + description: IPv4 type of proxy_id protocol values for TCP protocol oneOf: - type: object title: number @@ -7710,7 +7711,7 @@ components: properties: tcp: type: object - description: TCP + description: IPv4 type of proxy_id protocol values for TCP protocol properties: local_port: type: integer @@ -7727,7 +7728,7 @@ components: properties: udp: type: object - description: UDP + description: IPv6 type of proxy_id protocol values for UDP protocol properties: local_port: type: integer @@ -7746,6 +7747,7 @@ components: description: IPv6 type of proxy_id values items: type: object + description: IPv6 type of proxy_id values for TCP protocol properties: name: type: string @@ -7755,6 +7757,7 @@ components: type: string protocol: type: object + description: IPv6 type of proxy_id protocol values for protocol oneOf: - type: object title: number @@ -7769,7 +7772,7 @@ components: properties: tcp: type: object - description: TCP + description: IPv6 type of proxy_id protocol values for TCP protocol properties: local_port: type: integer @@ -7786,7 +7789,7 @@ components: properties: udp: type: object - description: UDP + description: IPv6 type of proxy_id protocol values for UDP protocol properties: local_port: type: integer @@ -7838,35 +7841,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: + required: - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: + required: - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: + required: - device - qos-policy-rules: type: object properties: @@ -7950,35 +7952,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: + required: - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: + required: - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: + required: - device - rule-based-move: type: object title: rule-based-move @@ -8001,7 +8002,6 @@ components: required: - destination - rulebase - qos-profiles: type: object properties: @@ -8112,35 +8112,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: + required: - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: + required: - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: + required: - device - zones: type: object properties: @@ -8226,35 +8225,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: + required: - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: + required: - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: + required: - device - zone-protection-profiles: type: object properties: @@ -8267,38 +8265,38 @@ components: description: The profile name type: string maxLength: 31 - description: + description: description: The description of the profile type: string maxLength: 255 - flood: + flood: type: object - properties: - tcp_syn: + properties: + tcp_syn: type: object - properties: + properties: enable: description: Enable protection against SYN floods? type: boolean oneOf: - title: red type: object - properties: - alarm_rate: + properties: + alarm_rate: description: When the flow exceeds the `alert_rate`` threshold, an alarm is generated. type: integer format: int32 minimum: 0 maximum: 2000000 example: 10000 - activate_rate: + activate_rate: description: When the flow exceeds the `activate_rate`` threshold, the firewall drops individual SYN packets randomly to restrict the flow. type: integer format: int32 minimum: 0 maximum: 2000000 example: 10000 - maximal_rate: + maximal_rate: description: When the flow exceeds the `maximal_rate` threshold, 100% of incoming SYN packets are dropped. type: integer format: int32 @@ -8311,22 +8309,22 @@ components: - maximal_rate - title: syn_cookies type: object - properties: - alarm_rate: + properties: + alarm_rate: description: When the flow exceeds the `alert_rate`` threshold, an alarm is generated. type: integer format: int32 minimum: 0 maximum: 2000000 example: 10000 - activate_rate: + activate_rate: description: When the flow exceeds the `activate_rate`` threshold, the firewall drops individual SYN packets randomly to restrict the flow. type: integer format: int32 minimum: 0 maximum: 2000000 example: 0 - maximal_rate: + maximal_rate: description: When the flow exceeds the `maximal_rate` threshold, 100% of incoming SYN packets are dropped. type: integer format: int32 @@ -8337,30 +8335,30 @@ components: - alarm_rate - activate_rate - maximal_rate - udp: + udp: type: object - properties: - enable: + properties: + enable: description: Enable protection against UDP floods? type: boolean - red: + red: type: object - properties: - alarm_rate: + properties: + alarm_rate: description: The number of UDP packets (not matching an existing session) that the zone receives per second that triggers an attack alarm. type: integer format: int32 minimum: 0 maximum: 2000000 example: 10000 - activate_rate: + activate_rate: description: The number of UDP packets (not matching an existing session) that the zone receives per second that triggers random dropping of UDP packets. type: integer format: int32 minimum: 0 maximum: 2000000 example: 10000 - maximal_rate: + maximal_rate: description: The maximum number of UDP packets (not matching an existing session) the zone receives per second before packets exceeding the maximum are dropped. type: integer format: int32 @@ -8371,30 +8369,30 @@ components: - alarm_rate - activate_rate - maximal_rate - sctp_init: + sctp_init: type: object - properties: - enable: + properties: + enable: description: Enable protection against floods of Stream Control Transmission Protocol (SCTP) packets that contain an Initiation (INIT) chunk? type: boolean - red: + red: type: object - properties: - alarm_rate: + properties: + alarm_rate: description: The number of SCTP INIT packets (not matching an existing session) that the zone receives per second that triggers an attack alarm. type: integer format: int32 minimum: 0 maximum: 2000000 example: 10000 - activate_rate: + activate_rate: description: The number of SCTP INIT packets (not matching an existing session) that the zone receives per second before subsequent SCTP INIT packets are dropped. type: integer format: int32 minimum: 0 maximum: 2000000 example: 10000 - maximal_rate: + maximal_rate: description: The maximum number of SCTP INIT packets (not matching an existing session) that the zone receives per second before packets exceeding the maximum are dropped. type: integer format: int32 @@ -8405,30 +8403,30 @@ components: - alarm_rate - activate_rate - maximal_rate - icmp: + icmp: type: object - properties: - enable: + properties: + enable: description: Enable protection against ICMP floods? type: boolean - red: + red: type: object - properties: - alarm_rate: + properties: + alarm_rate: description: The number of ICMP echo requests (pings not matching an existing session) that the zone receives per second that triggers an attack alarm. type: integer format: int32 minimum: 0 maximum: 2000000 example: 10000 - activate_rate: + activate_rate: description: The number of ICMP packets (not matching an existing session) that the zone receives per second before subsequent ICMP packets are dropped. type: integer format: int32 minimum: 0 maximum: 2000000 example: 10000 - maximal_rate: + maximal_rate: description: The maximum number of ICMP packets (not matching an existing session) that the zone receives per second before packets exceeding the maximum are dropped. type: integer format: int32 @@ -8439,30 +8437,30 @@ components: - alarm_rate - activate_rate - maximal_rate - icmpv6: + icmpv6: type: object - properties: - enable: + properties: + enable: description: Enable protection against ICMPv6 floods? type: boolean - red: + red: type: object - properties: - alarm_rate: + properties: + alarm_rate: description: The number of ICMPv6 echo requests (pings not matching an existing session) that the zone receives per second that triggers an attack alarm. type: integer format: int32 minimum: 0 maximum: 2000000 example: 10000 - activate_rate: + activate_rate: description: The number of ICMPv6 packets (not matching an existing session) that the zone receives per second before subsequent ICMPv6 packets are dropped. type: integer format: int32 minimum: 0 maximum: 2000000 example: 10000 - maximal_rate: + maximal_rate: description: The maximum number of ICMPv6 packets (not matching an existing session) that the zone receives per second before packets exceeding the maximum are dropped. type: integer format: int32 @@ -8473,28 +8471,28 @@ components: - alarm_rate - activate_rate - maximal_rate - other_ip: + other_ip: type: object - properties: - enable: + properties: + enable: description: Enable protection against other IP (non-TCP, non-ICMP, non-ICMPv6, non-SCTP, and non-UDP) floods? type: boolean - red: + red: type: object - properties: - alarm_rate: + properties: + alarm_rate: type: integer format: int32 minimum: 0 maximum: 2000000 example: 10000 - activate_rate: + activate_rate: type: integer format: int32 minimum: 0 maximum: 2000000 example: 10000 - maximal_rate: + maximal_rate: type: integer format: int32 minimum: 0 @@ -8504,12 +8502,12 @@ components: - alarm_rate - activate_rate - maximal_rate - scan: + scan: type: array - items: + items: type: object - properties: - name: + properties: + name: description: | The threat ID number. These can be found in [Palo Alto Networks ThreatVault](https://threatvault.paloaltonetworks.com). * "8001" - TCP Port Scan @@ -8518,28 +8516,28 @@ components: * "8006" - Port Scan type: string enum: - - "8001" - - "8002" - - "8003" - - "8006" - action: + - "8001" + - "8002" + - "8003" + - "8006" + action: type: object oneOf: - title: allow type: object - - title: alert + - title: alert type: object - - title: block - type: object - - title: block_ip + - title: block type: object - properties: - track_by: + - title: block_ip + type: object + properties: + track_by: type: string enum: - source-and-destination - source - duration: + duration: type: integer format: int32 minimum: 1 @@ -8547,13 +8545,13 @@ components: required: - track_by - duration - interval: + interval: type: integer format: int32 minimum: 2 maximum: 65535 example: 2 - threshold: + threshold: type: integer format: int32 minimum: 2 @@ -8561,19 +8559,19 @@ components: example: 100 required: - name - scan_white_list: + scan_white_list: type: array - items: + items: type: object - properties: - name: + properties: + name: description: A descriptive name for the address to exclude. type: string oneOf: - - title: ipv4 + - title: ipv4 type: string format: ipv4 - - title: ipv6 + - title: ipv6 type: string format: ipv6 required: @@ -8622,7 +8620,7 @@ components: Discard packets if the class and number are unknown. type: boolean malformed_option_discard: - description: | + description: | Discard packets if they have incorrect combinations of class, number, and length based on RFCs 791, 1108, 1393, and 2113. type: boolean mismatched_overlapping_tcp_segment_discard: @@ -8651,9 +8649,9 @@ components: * `no` — Accept non-SYN TCP. type: string enum: - - global - - yes - - no + - global + - yes + - no asymmetric_path: description: | Determine whether to drop or bypass packets that contain out-of-sync ACKs or out-of-window sequence numbers: @@ -8662,11 +8660,11 @@ components: * `bypass` — Bypass scanning on packets that contain an asymmetric path. type: string enum: - - global - - drop - - bypass + - global + - drop + - bypass tcp_timestamp_strip: - description: | + description: | Determine whether the packet has a TCP timestamp in the header and, if it does, strip the timestamp from the header. type: boolean tcp_fast_open_and_data_strip: @@ -8681,9 +8679,9 @@ components: * `global` — Support MPTCP based on the global MPTCP setting. By default, the global MPTCP setting is set to yes so that MPTCP is disabled (the MPTCP option is stripped from the packet). type: string enum: - - no - - yes - - global + - no + - yes + - global default: global icmp_ping_zero_id_discard: description: | @@ -8705,169 +8703,168 @@ components: description: | Stop sending ICMP fragmentation needed messages in response to packets that exceed the interface MTU and have the do not fragment (DF) bit set. This setting will interfere with the PMTUD process performed by hosts behind the firewall. type: boolean - ipv6: + ipv6: type: object - properties: - routing_header_0: + properties: + routing_header_0: description: Drop packets with type 0 routing header. type: boolean - routing_header_1: + routing_header_1: description: Drop packets with type 1 routing header. type: boolean - routing_header_3: + routing_header_3: description: Drop packets with type 3 routing header. type: boolean - routing_header_4_252: + routing_header_4_252: description: Drop packets with type 4 to type 252 routing header. type: boolean - routing_header_253: + routing_header_253: description: Drop packets with type 253 routing header. type: boolean - routing_header_254: + routing_header_254: description: Drop packets with type 254 routing header. type: boolean - routing_header_255: + routing_header_255: description: Drop packets with type 255 routing header. type: boolean - ipv4_compatible_address: + ipv4_compatible_address: description: Discard IPv6 packets that are defined as an RFC 4291 IPv4-Compatible IPv6 address. type: boolean - filter_ext_hdr: + filter_ext_hdr: type: object - properties: - hop_by_hop_hdr: + properties: + hop_by_hop_hdr: description: Discard IPv6 packets that contain the Hop-by-Hop Options extension header. type: boolean - routing_hdr: + routing_hdr: description: Discard IPv6 packets that contain the Routing extension header, which directs packets to one or more intermediate nodes on its way to its destination. type: boolean - dest_option_hdr: + dest_option_hdr: description: Discard IPv6 packets that contain the Destination Options extension, which contains options intended only for the destination of the packet. type: boolean - options_invalid_ipv6_discard: + options_invalid_ipv6_discard: description: Discard IPv6 packets that contain invalid IPv6 options in an extension header. type: boolean reserved_field_set_discard: description: Discard IPv6 packets that have a header with a reserved field not set to zero. type: boolean - anycast_source: + anycast_source: description: Discard IPv6 packets that contain an anycast source address. type: boolean - needless_fragment_hdr: + needless_fragment_hdr: description: Discard IPv6 packets with the last fragment flag (M=0) and offset of zero. type: boolean - icmpv6_too_big_small_mtu_discard: + icmpv6_too_big_small_mtu_discard: description: Discard IPv6 packets that contain a Packet Too Big ICMPv6 message when the maximum transmission unit (MTU) is less than 1,280 bytes. type: boolean - ignore_inv_pkt: + ignore_inv_pkt: type: object - properties: - dest_unreach: + properties: + dest_unreach: description: Require an explicit Security policy match for Destination Unreachable ICMPv6 messages, even when the message is associated with an existing session. type: boolean - pkt_too_big: + pkt_too_big: description: Require an explicit Security policy match for Packet Too Big ICMPv6 messages, even when the message is associated with an existing session. type: boolean - time_exceeded: + time_exceeded: description: Require an explicit Security policy match for Time Exceeded ICMPv6 messages, even when the message is associated with an existing session. type: boolean - param_problem: + param_problem: description: Require an explicit Security policy match for Parameter Problem ICMPv6 messages, even when the message is associated with an existing session. type: boolean - redirect: + redirect: description: Require an explicit Security policy match for Redirect Message ICMPv6 messages, even when the message is associated with an existing session. type: boolean - non_ip_protocol: + non_ip_protocol: type: object - properties: - list_type: + properties: + list_type: description: | Specify the type of list you are creating for protocol protection: * Include List—Only the protocols on the list are allowed—in addition to IPv4 (0x0800), IPv6 (0x86DD), ARP (0x0806), and VLAN tagged frames (0x8100). All other protocols are implicitly denied (blocked). * Exclude List—Only the protocols on the list are denied; all other protocols are implicitly allowed. You cannot exclude IPv4 (0x0800), IPv6 (0x86DD), ARP (0x0806), or VLAN tagged frames (0x8100). type: string enum: - - exclude - - include - protocol: + - exclude + - include + protocol: type: array - items: + items: type: object - properties: - name: + properties: + name: description: | Enter the protocol name that corresponds to the Ethertype code you are adding to the list. The firewall does not verify that the protocol name matches the Ethertype code but the Ethertype code does determine the protocol filter. type: string - ether_type: + ether_type: description: | Enter an Ethertype code (protocol) preceded by 0x to indicate hexadecimal (range is 0x0000 to 0xFFFF). A list can have a maximum of 64 Ethertypes. Some sources of Ethertype codes are: * [IEEE hexadecimal Ethertype](http://www.iana.org/assignments/ieee-802-numbers/ieee-802-numbers.xhtml) * [standards.ieee.org/develop/regauth/ethertype/eth.txt](http://standards-oui.ieee.org/ethertype/eth.txt) * [http://www.cavebear.com/archive/cavebear/Ethernet/type.html](http://www.cavebear.com/archive/cavebear/Ethernet/type.html) type: string - enable: + enable: description: Enable the Ethertype code on the list. type: boolean required: - name - ether_type - l2_sec_group_tag_protection: + l2_sec_group_tag_protection: type: object - properties: - tags: + properties: + tags: type: array - items: + items: type: object - properties: - name: + properties: + name: description: Name for the list of Security Group Tags (SGTs). type: string - tag: + tag: description: The Layer 2 SGTs in headers of packets that you want to exclude (drop) when the SGT matches this list in the Zone Protection profile applied to a zone (range is 0 to 65,535). type: string - enable: - description: Enable this exclude list for Ethernet SGT protection. + enable: + description: Enable this exclude list for Ethernet SGT protection. type: boolean required: - name - tag required: - - name + - name oneOf: - type: object title: folder properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: + required: - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: + required: - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: + required: - device - nat-rules: type: object required: @@ -8890,10 +8887,10 @@ components: description: description: NAT rule description type: string - tag: + tag: description: NAT rule tags type: array - items: + items: type: string disabled: description: Disable NAT rule? @@ -8910,35 +8907,35 @@ components: from: description: Source zone(s) of the original packet type: array - items: + items: type: string example: - - any + - any source: description: Source address(es) of the original packet type: array items: type: string example: - - any + - any to: description: Destination zone of the original packet type: array - items: + items: type: string example: - - any - to_interface: + - any + to_interface: description: Destination interface of the original packet type: string example: any destination: description: Destination address(es) of the original packet type: array - items: + items: type: string example: - - any + - any service: description: The service of the original packet type: string @@ -8959,8 +8956,8 @@ components: - title: interface_address description: Translated source interface type: object - properties: - interface: + properties: + interface: description: Interface name type: string oneOf: @@ -8973,7 +8970,7 @@ components: - title: dynamic_ip description: Dynamic IP type: object - properties: + properties: translated_address_array: description: Translated IP addresses type: array @@ -8986,12 +8983,12 @@ components: - title: translated_address_array description: Fallback IP addresses type: array - items: + items: type: string - title: interface_address description: Fallback interface type: object - properties: + properties: interface: description: Interface name type: string @@ -9000,18 +8997,18 @@ components: description: IP address type: string - title: floating_ip - description: Floating IP address + description: Floating IP address type: string - title: static_ip description: Static IP type: object - properties: + properties: translated_address_single: description: Translated IP address type: string - bi_directional: + bi_directional: type: boolean - active_active_device_binding: + active_active_device_binding: type: string enum: - primary @@ -9020,83 +9017,82 @@ components: - "1" anyOf: - oneOf: - - title: destination_translation - description: Destination translation - type: object - properties: - translated_address_single: - description: Translated destination IP address - type: string - translated_port: - description: Translated destination port - type: integer - minimum: 1 - maximum: 65535 - dns_rewrite: - description: DNS rewrite - type: object - properties: - direction: - type: string - enum: - - reverse - - forward - - title: dynamic_destination_translation - description: Dynamic destination translation - type: object - properties: - translated_address_single: - description: Translated destination IP address - type: string - translated_port: - description: Translated destination port - type: integer - minimum: 1 - maximum: 65535 - distribution: - description: Distribution method - type: string - enum: - - round-robin - - source-ip-hash - - ip-modulo - - ip-hash - - least-sessions + - title: destination_translation + description: Destination translation + type: object + properties: + translated_address_single: + description: Translated destination IP address + type: string + translated_port: + description: Translated destination port + type: integer + minimum: 1 + maximum: 65535 + dns_rewrite: + description: DNS rewrite + type: object + properties: + direction: + type: string + enum: + - reverse + - forward + - title: dynamic_destination_translation + description: Dynamic destination translation + type: object + properties: + translated_address_single: + description: Translated destination IP address + type: string + translated_port: + description: Translated destination port + type: integer + minimum: 1 + maximum: 65535 + distribution: + description: Distribution method + type: string + enum: + - round-robin + - source-ip-hash + - ip-modulo + - ip-hash + - least-sessions - oneOf: - type: object title: folder properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: + required: - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: + required: - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: + required: - device - aggregate-ethernet-interfaces: type: object required: @@ -9110,7 +9106,7 @@ components: name: description: Aggregate interface name type: string - default-value: + default_value: description: Default interface assignment type: string comment: @@ -9119,90 +9115,92 @@ components: minLength: 0 maxLength: 1023 anyOf: - - oneOf: - - title: layer2 - required: - - layer2 - properties: - layer2: - type: object + - oneOf: + - title: layer2 + required: + - layer2 properties: - vlan-tag: - description: Assign interface to VLAN tag - type: integer - minimum: 1 - maximum: 9999 - lacp: - $ref: '#/components/schemas/lacp' - - title: layer3 - required: - - layer3 - properties: - layer3: - type: object - oneOf: - - title: static - type: object - properties: - ip: - description: Interface IP addresses - type: array - items: + layer2: + type: object + properties: + vlan_tag: + description: Assign interface to VLAN tag + type: integer + minimum: 1 + maximum: 9999 + lacp: + $ref: '#/components/schemas/lacp' + - title: layer3 + required: + - layer3 + properties: + layer3: + type: object + oneOf: + - title: static + type: object + properties: + ip: + description: Interface IP addresses + type: array + items: + type: string + - title: dhcp + $ref: '#/components/schemas/agg-ethernet-dhcp-client' + properties: + mtu: + description: MTU + type: integer + minimum: 576 + maximum: 9216 + default: 1500 + arp: + $ref: '#/components/schemas/agg-ethernet-arp' + ddns_config: + type: object + description: Dynamic DNS configuration specific to the Aggregate Ethernet Interface. + allOf: + - $ref: '#/components/schemas/ddns-config' + interface_management_profile: + description: Interface management profile type: string - - title: dhcp - $ref: '#/components/schemas/dhcp-client' + maxLength: 31 + lacp: + $ref: '#/components/schemas/lacp' + - oneOf: + - type: object + title: folder properties: - mtu: - description: MTU - type: integer - minimum: 576 - maximum: 9216 - default: 1500 - arp: - $ref: '#/components/schemas/arp' - ddns-config: - $ref: '#/components/schemas/ddns-config' - interface-management-profile: - description: Interface management profile + folder: type: string - maxLength: 31 - lacp: - $ref: '#/components/schemas/lacp' - - oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device lacp: type: object properties: @@ -9210,7 +9208,7 @@ components: description: Enable LACP? type: boolean default: false - fast-failover: + fast_failover: description: Fast failover type: boolean default: false @@ -9221,41 +9219,150 @@ components: - passive - active default: passive - transmission-rate: + transmission_rate: description: Transmission mode type: string enum: - fast - slow default: slow - system-priority: + system_priority: description: LACP system priority in system ID type: integer minimum: 1 maximum: 65535 default: 32768 - max-ports: + max_ports: description: Maximum number of physical ports bundled in the LAG type: integer minimum: 1 maximum: 8 default: 8 - - dhcp-client: + agg-ethernet-dhcp-client: + type: object + description: Aggregate Ethernet DHCP Client + properties: + dhcp_client: + type: object + description: Aggregate Ethernet DHCP Client Object + properties: + enable: + description: Enable DHCP? + type: boolean + default: true + create_default_route: + description: Automatically create default route pointing to default gateway provided by server + type: boolean + default: true + send_hostname: + description: Aggregate Ethernet DHCP Client Send hostname + type: object + properties: + enable: + type: boolean + default: true + hostname: + description: Set interface hostname + type: string + minLength: 1 + maxLength: 64 + pattern: '^[a-zA-Z0-9\._-]+$' + default: system-hostname + default_route_metric: + description: Metric of the default route created + type: integer + minimum: 1 + maximum: 65535 + default: 10 + ethernet-interfaces-dhcp-client: + type: object + description: Ethernet Interfaces DHCP Client + properties: + dhcp_client: + type: object + description: Ethernet Interfaces DHCP Client Object + properties: + enable: + description: Enable DHCP? + type: boolean + default: true + create_default_route: + description: Automatically create default route pointing to default gateway provided by server + type: boolean + default: true + send_hostname: + description: Ethernet Interfaces DHCP ClientSend hostname + type: object + properties: + enable: + type: boolean + default: true + hostname: + description: Set interface hostname + type: string + minLength: 1 + maxLength: 64 + pattern: '^[a-zA-Z0-9\._-]+$' + default: system-hostname + default_route_metric: + description: Metric of the default route created + type: integer + minimum: 1 + maximum: 65535 + default: 10 + layer3-sub-interfaces-dhcp-client: + type: object + description: Layer3 sub interfaces DHCP Client + properties: + dhcp_client: + type: object + description: Layer3 sub interfaces DHCP Client Object + properties: + enable: + description: Enable DHCP? + type: boolean + default: true + create_default_route: + description: Automatically create default route pointing to default gateway provided by server + type: boolean + default: true + send_hostname: + description: Layer3 sub interfaces DHCP Client Send hostname + type: object + properties: + enable: + type: boolean + default: true + hostname: + description: Set interface hostname + type: string + minLength: 1 + maxLength: 64 + pattern: '^[a-zA-Z0-9\._-]+$' + default: system-hostname + default_route_metric: + description: Metric of the default route created + type: integer + minimum: 1 + maximum: 65535 + default: 10 + vlan-interfaces-dhcp-client: type: object - properties: - dhcp-client: + description: Vlan interfaces DHCP Client + properties: + dhcp_client: type: object + description: Vlan interfaces DHCP Client Object properties: enable: description: Enable DHCP? type: boolean default: true - create-default-route: + create_default_route: description: Automatically create default route pointing to default gateway provided by server type: boolean default: true - send-hostname: + send_hostname: description: Send hostname type: object properties: @@ -9266,59 +9373,57 @@ components: description: Set interface hostname type: string minLength: 1 - maxLength: 64 + maxLength: 64 pattern: '^[a-zA-Z0-9\._-]+$' default: system-hostname - default-route-metric: + default_route_metric: description: Metric of the default route created type: integer minimum: 1 maximum: 65535 default: 10 - ddns-config: type: object required: - - ddns-hostname - - ddns-cert-profile - - ddns-vendor - - ddns-vendor-config + - ddns_hostname + - ddns_cert_profile + - ddns_vendor + - ddns_vendor_config properties: - ddns-enabled: + ddns_enabled: description: Enable DDNS? type: boolean default: false - ddns-vendor: + ddns_vendor: description: DDNS vendor type: string maxLength: 127 - ddns-update-interval: + ddns_update_interval: description: Update interval (days) type: integer minimum: 1 maximum: 30 default: 1 - ddns-cert-profile: + ddns_cert_profile: description: Certificate profile type: string - ddns-hostname: + ddns_hostname: type: string pattern: '^[a-zA-Z0-9_\.\-]+$' maxLength: 255 - ddns-ip: + ddns_ip: description: IP to register (static only) type: string format: ip-address - ddns-vendor-config: + ddns_vendor_config: description: DDNS vendor type: string maxLength: 255 - ethernet-interfaces: type: object required: - - id - - name + - id + - name properties: id: type: string @@ -9328,7 +9433,7 @@ components: name: description: Interface name type: string - default-value: + default_value: description: Default interface assignment type: string comment: @@ -9336,7 +9441,7 @@ components: type: string minLength: 0 maxLength: 1023 - link-speed: + link_speed: description: Link speed type: string enum: @@ -9348,7 +9453,7 @@ components: - '40000' - '100000' default: auto - link-duplex: + link_duplex: description: Link duplex type: string enum: @@ -9356,7 +9461,7 @@ components: - half - full default: auto - link-state: + link_state: description: Link state type: string enum: @@ -9365,189 +9470,225 @@ components: - down default: auto poe: - $ref: '#/components/schemas/poe' + $ref: '#/components/schemas/poe' anyOf: - - oneOf: - - title: tap - properties: - tap: - type: object - default: {} - - title: layer2 - required: - - layer2 - properties: - layer2: - type: object + - oneOf: + - title: tap properties: - vlan-tag: - description: Assign interface to VLAN tag - type: integer - minimum: 1 - maximum: 9999 - - title: layer3 - required: - - layer3 - properties: - layer3: - type: object - oneOf: - - title: static - type: object - properties: - ip: - description: Interface IP addresses - type: array - items: - type: string - - title: dhcp - type: object - properties: - dhcp-client: - $ref: "#/components/schemas/dhcp-client" - - title: pppoe - type: object - properties: - pppoe: - type: object - required: - - username - - password - properties: - enable: - type: boolean - default: true - username: - description: Username - type: string - minLength: 1 - maxLength: 255 - password: - description: Password - type: string - format: password - maxLength: 255 - authentication: - description: Authentication protocol - type: string - enum: - - CHAP - - PAP - - auto - static-address: - type: object - required: - - ip - properties: - ip: - description: Static IP address - type: string - maxLength: 63 - default-route-metric: - description: Metric of the default route created - type: integer - minimum: 1 - maximum: 65535 - default: 10 - access-concentrator: - description: Access concentrator - type: string - minLength: 1 - maxLength: 255 - service: - description: Service - type: string - minLength: 1 - maxLength: 255 - passive: - description: Passive - type: boolean - default: false + tap: + type: object + default: {} + - title: layer2 + required: + - layer2 + properties: + layer2: + type: object + properties: + vlan_tag: + description: Assign interface to VLAN tag + type: integer + minimum: 1 + maximum: 9999 + - title: layer3 + required: + - layer3 + properties: + layer3: + type: object + oneOf: + - title: static + type: object + properties: + ip: + description: Interface IP addresses + type: array + items: + type: object + required: + - name + properties: + name: + type: string + - title: dhcp + type: object + $ref: "#/components/schemas/ethernet-interfaces-dhcp-client" + - title: pppoe + type: object + properties: + pppoe: + type: object + required: + - username + - password + properties: + enable: + type: boolean + default: true + username: + description: Username + type: string + minLength: 1 + maxLength: 255 + password: + description: Password + type: string + format: password + maxLength: 255 + authentication: + description: Authentication protocol + type: string + enum: + - CHAP + - PAP + - auto + static_address: + type: object + required: + - ip + properties: + ip: + description: Static IP address + type: string + maxLength: 63 + default_route_metric: + description: Metric of the default route created + type: integer + minimum: 1 + maximum: 65535 + default: 10 + access_concentrator: + description: Access concentrator + type: string + minLength: 1 + maxLength: 255 + service: + description: Service + type: string + minLength: 1 + maxLength: 255 + passive: + description: Passive + type: boolean + default: false + properties: + interface_management_profile: + description: Interface management profile + type: string + maxLength: 31 + mtu: + description: MTU + type: integer + minimum: 576 + maximum: 9216 + default: 1500 + arp: + $ref: '#/components/schemas/ethernet-interfaces-arp' + ddns_config: + type: object + description: Dynamic DNS configuration specific to the Ethernet Interfaces. + allOf: + - $ref: '#/components/schemas/ddns-config' + - oneOf: + - type: object + title: folder properties: - interface-management-profile: - description: Interface management profile + folder: type: string - maxLength: 31 - mtu: - description: MTU - type: integer - minimum: 576 - maximum: 9216 - default: 1500 - arp: - $ref: '#/components/schemas/arp' - ddns-config: - $ref: "#/components/schemas/ddns-config" - - oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - - poe: - type: object - properties: - poe-enabled: - description: Enabled PoE? - type: boolean - default: false - poe-rsvd-pwr: - description: PoE reserved power - type: integer - minimum: 0 - maximum: 90 - default: 0 - - arp: - description: ARP configuration - type: array - items: - type: object - properties: - name: - description: IP address - type: string - format: ip-address - hw-address: - description: MAC address + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device + poe: + type: object + properties: + poe_enabled: + description: Enabled PoE? + type: boolean + default: false + poe_rsvd_pwr: + description: PoE reserved power + type: integer + minimum: 0 + maximum: 90 + default: 0 + agg-ethernet-arp: + description: Aggregate Ethernet ARP configuration + type: array + items: + type: object + description: Aggregate Ethernet ARP configuration object + properties: + name: + description: IP address + type: string + format: ip-address + hw_address: + description: MAC address + type: string + format: mac-address + default: {} + ethernet-interfaces-arp: + description: Ethernet Interfaces ARP configuration + type: array + items: + type: object + description: Ethernet Interfaces ARP configuration object + properties: + name: + description: IP address + type: string + format: ip-address + hw_address: + description: MAC address + type: string + format: mac-address + default: {} + layer3-subinterfaces-arp: + description: Layer 3 sub Interfaces ARP configuration + type: array + items: + type: object + description: Layer 3 sub Interfaces ARP configuration object + properties: + name: + description: IP address + type: string + format: ip-address + hw_address: + description: MAC address type: string format: mac-address default: {} - layer2-subinterfaces: type: object required: - - name - - vlan-tag + - name + - vlan-tag properties: id: type: string @@ -9561,12 +9702,12 @@ components: comment: description: Description type: string - vlan-tag: + vlan_tag: description: VLAN tag type: number minimum: 1 maximum: 9999 - parent-interface: + parent_interface: description: Parent interface type: string oneOf: @@ -9575,39 +9716,38 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: + required: - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: + required: - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: + required: - device - layer3-subinterfaces: type: object required: - - name + - name properties: id: type: string @@ -9630,67 +9770,69 @@ components: type: string mtu: description: MTU - type: number + type: integer minimum: 576 maximum: 9216 ddns_config: - $ref: '#/components/schemas/ddns-config' + type: object + description: Dynamic DNS configuration specific to the Layer 3 sub Interfaces. + allOf: + - $ref: '#/components/schemas/ddns-config' arp: - $ref: "#/components/schemas/arp" + $ref: "#/components/schemas/layer3-subinterfaces-arp" interface_management_profile: description: Interface management profile type: string example: string anyOf: - oneOf: - - title: static - type: object - properties: - ip: - type: array - items: - type: string - - title: dhcp - $ref: '#/components/schemas/dhcp-client' + - title: static + type: object + properties: + ip: + type: array + items: + type: string + - title: dhcp + $ref: '#/components/schemas/layer3-sub-interfaces-dhcp-client' - oneOf: - type: object title: folder properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: + required: - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: + required: - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: + required: - device - loopback-interfaces: type: object required: - - name + - name properties: id: type: string @@ -9699,8 +9841,9 @@ components: example: 123e4567-e89b-12d3-a456-426655440000 name: description: L3 sub-interface name + pattern: '^\$[a-zA-Z\d\-_\. ]+$' type: string - default-value: + default_value: description: Default interface assignment type: integer minimum: 1 @@ -9710,7 +9853,7 @@ components: type: string mtu: description: MTU - type: number + type: integer minimum: 576 maximum: 9216 interface_management_profile: @@ -9718,52 +9861,54 @@ components: type: string example: string ip: - type: object - properties: - ip: - description: IP address(es) - type: array - items: + description: loopback ip parent + type: array + items: + type: object + properties: + name: type: string + description: Loopback IP address(es) + required: + - name oneOf: - type: object title: folder properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: + required: - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: + required: - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: + required: - device - tunnel-interfaces: type: object required: - - name + - name properties: id: type: string @@ -9773,7 +9918,7 @@ components: name: description: L3 sub-interface name type: string - default-value: + default_value: description: Default interface assignment type: integer minimum: 1 @@ -9783,7 +9928,7 @@ components: type: string mtu: description: MTU - type: number + type: integer minimum: 576 maximum: 9216 interface_management_profile: @@ -9792,9 +9937,10 @@ components: example: string ip: type: object + description: tunnel interfaces ip parent properties: ip: - description: IP address(es) + description: tunnel interfaces IP address(es) type: array items: type: string @@ -9804,39 +9950,38 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: + required: - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: + required: - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: + required: - device - vlan-interfaces: type: object required: - - name + - name properties: id: type: string @@ -9846,24 +9991,27 @@ components: name: description: L3 sub-interface name type: string - default-value: + default_value: description: Default interface assignment type: string comment: description: Description type: string - vlan-tag: + vlan_tag: description: VLAN tag type: number minimum: 1 maximum: 4096 mtu: description: MTU - type: number + type: integer minimum: 576 maximum: 9216 ddns_config: - $ref: '#/components/schemas/ddns-config' + type: object + description: Dynamic DNS configuration specific to the Vlan Interfaces. + allOf: + - $ref: '#/components/schemas/ddns-config' arp: description: ARP configuration type: array @@ -9874,7 +10022,7 @@ components: description: IP address type: string format: ip-address - hw-address: + hw_address: description: MAC address type: string format: mac-address @@ -9887,50 +10035,49 @@ components: example: string anyOf: - oneOf: - - title: static - type: object - properties: - ip: - type: array - items: - type: string - - title: dhcp - $ref: '#/components/schemas/dhcp-client' + - title: static + type: object + properties: + ip: + type: array + items: + type: string + - title: dhcp + $ref: '#/components/schemas/vlan-interfaces-dhcp-client' - oneOf: - type: object title: folder properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: + required: - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: + required: - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: + required: - device - interface-management-profiles: type: object required: @@ -9952,29 +10099,29 @@ components: type: boolean telnet: description: Allow telnet? Seriously, why would you do this?!? - type: boolean + type: boolean ssh: description: Allow SSH? type: boolean ping: description: Allow ping? type: boolean - http-ocsp: + http_ocsp: description: Allow HTTP OCSP? type: boolean - response-pages: + response_pages: description: Allow response pages? default: boolean - userid-service: + userid_service: description: Allow User-ID? type: boolean - userid-syslog-listener-ssl: + userid_syslog_listener_ssl: description: Allow User-ID syslog listener (SSL)? type: boolean - userid-syslog-listener-udp: + userid_syslog_listener_udp: description: Allow User-ID syslog listener (UDP)? type: boolean - permitted-ip: + permitted_ip: description: Allowed IP address(es) type: array items: @@ -9985,35 +10132,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: + required: - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: + required: - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device - + required: + - device bgp-address-family-profiles: type: object required: @@ -10044,35 +10190,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: + required: - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: + required: - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: + required: - device - bgp-address-family: type: object properties: @@ -10230,7 +10375,6 @@ components: - both - receive - send - bgp-auth-profiles: type: object required: @@ -10249,40 +10393,39 @@ components: type: string format: password oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device bgp-filtering-profiles: type: object required: @@ -10308,47 +10451,46 @@ components: $ref: '#/components/schemas/bgp-filter' multicast: oneOf: - - type: object - properties: - inherit: - description: Inherit from unicast - type: boolean - - $ref: '#/components/schemas/bgp-filter' + - type: object + properties: + inherit: + description: Inherit from unicast + type: boolean + - $ref: '#/components/schemas/bgp-filter' oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device bgp-filter: type: object properties: @@ -10399,7 +10541,6 @@ components: type: string unsuppress_map: type: string - bgp-redistribution-profiles: type: object required: @@ -10463,860 +10604,870 @@ components: description: Route map type: string oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - - bgp-route-map-redistributions: - type: object - required: - - name - properties: - id: - type: string - description: UUID of the resource - readOnly: true - example: 123e4567-e89b-12d3-a456-426655440000 - name: - description: Name - type: string - description: - description: Description - type: string - anyOf: - - oneOf: - - title: bgp - required: - - bgp - properties: - bgp: - type: object - oneOf: - - title: ospf - required: - - ospf - properties: - ospf: - type: object - properties: - route_map: - description: Route maps - type: array - items: - type: object - properties: - name: - description: Sequence number - type: integer - minimum: 1 - maximum: 65535 - action: - description: Action - type: string - enum: - - permit - - deny - description: - description: Description - type: string - match: - type: object - properties: - as_path_access_list: - description: AS path access list - type: string - regular_community: - description: Regular community - type: string - large_community: - description: Large community - type: string - extended_community: - description: Extended community - type: string - interface: - description: Interface - type: string - origin: - description: Origin - type: string - metric: - description: Metric - type: integer - minimum: 0 - maximum: 4294967295 - tag: - description: Tag - type: integer - minimum: 1 - maximum: 4294967295 - local_preference: - description: Local preference - type: integer - minimum: 1 - maximum: 4294967295 - peer: - description: Peer - type: string - enum: - - local - - none - ipv4: - type: object - properties: - address: - type: object - properties: - access_list: - description: Access list - type: string - prefix_list: - description: Prefix list - type: string - next_hop: - type: object - properties: - access_list: - description: Access list - type: string - prefix_list: - description: Prefix list - type: string - route_source: - type: object - properties: - access_list: - description: Access list - type: string - prefix_list: - description: Prefix list - type: string - set: - type: object - properties: - metric: - type: object - properties: - value: - description: Metric value - type: integer - minimum: 0 - maximum: 4294967295 - action: - description: Metric action - type: string - enum: - - set - - add - - subtract - metric_type: - description: Metric type - type: string - enum: - - type-1 - - type-2 - tag: - description: Tag - type: integer - minimum: 1 - maximum: 4294967295 - - title: rib - required: - - rib - properties: - rib: - type: object - properties: - route_map: - description: Route maps - type: array - items: - type: object - properties: - name: - description: Sequence number - type: integer - minimum: 1 - maximum: 65535 - action: - description: Action - type: string - enum: - - permit - - deny - description: - description: Description - type: string - match: - type: object - properties: - as_path_access_list: - description: AS path access list - type: string - regular_community: - description: Regular community - type: string - large_community: - description: Large community - type: string - extended_community: - description: Extended community - type: string - interface: - description: Interface - type: string - origin: - description: Origin - type: string - metric: - description: Metric - type: integer - minimum: 0 - maximum: 4294967295 - tag: - description: Tag - type: integer - minimum: 1 - maximum: 4294967295 - local_preference: - description: Local preference - type: integer - minimum: 1 - maximum: 4294967295 - peer: - description: Peer - type: string - enum: - - local - - none - ipv4: - type: object - properties: - address: - type: object - properties: - access_list: - description: Access list - type: string - prefix_list: - description: Prefix list - type: string - next_hop: - type: object - properties: - access_list: - description: Access list - type: string - prefix_list: - description: Prefix list - type: string - route_source: - type: object - properties: - access_list: - description: Access list - type: string - prefix_list: - description: Prefix list - type: string - set: - type: object - properties: - source_address: - description: Source address - type: string - - title: ospf - required: - - ospf - properties: - ospf: - type: object - oneOf: - - title: bgp - required: - - bgp - properties: - bgp: - type: object - properties: - route_map: - description: Route maps - type: array - items: - type: object - properties: - name: - description: Sequence number - type: integer - minimum: 1 - maximum: 65535 - action: - description: Action - type: string - enum: - - permit - - deny - description: - description: Description - type: string - match: - type: object - properties: - interface: - description: Interface - type: string - metric: - description: Metric - type: integer - minimum: 0 - maximum: 4294967295 - tag: - description: Tag - type: integer - minimum: 1 - maximum: 4294967295 - address: - type: object - properties: - access_list: - description: Access list - type: string - prefix_list: - description: Prefix list - type: string - next_hop: - type: object - properties: - access_list: - description: Access list - type: string - prefix_list: - description: Prefix list - type: string - set: - type: object - properties: - atomic_aggregate: - description: Enable BGP atomic aggregate? - type: boolean - local_preference: - description: Local preference - type: integer - minimum: 0 - maximum: 4294967295 - tag: - description: Tag - type: integer - minimum: 1 - maximum: 4294967295 - metric: - type: object - properties: - action: - description: Metric action - type: string - enum: - - set - - add - - substract - value: - description: Metric value - type: integer - minimum: 0 - maximum: 4294967295 - weight: - description: Weight - type: integer - minimum: 0 - maximum: 4294967295 - origin: - description: Origin - type: string - enum: - - none - - egp - - igp - - incomplete - originator_id: - description: Originator ID - type: string - aggregator: - type: object - properties: - as: - description: Aggregator AS + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device + bgp-route-map-redistributions: + type: object + required: + - name + properties: + id: + type: string + description: UUID of the resource + readOnly: true + example: 123e4567-e89b-12d3-a456-426655440000 + name: + description: Name + type: string + description: + description: Description + type: string + anyOf: + - oneOf: + - title: bgp + required: + - bgp + properties: + bgp: + type: object + oneOf: + - title: ospf + required: + - ospf + properties: + ospf: + type: object + properties: + route_map: + description: Route maps + type: array + items: + type: object + properties: + name: + description: Sequence number + type: integer + minimum: 1 + maximum: 65535 + action: + description: Action + type: string + enum: + - permit + - deny + description: + description: Description + type: string + match: + type: object + properties: + as_path_access_list: + description: AS path access list + type: string + regular_community: + description: Regular community + type: string + large_community: + description: Large community + type: string + extended_community: + description: Extended community + type: string + interface: + description: Interface + type: string + origin: + description: Origin + type: string + metric: + description: Metric + type: integer + minimum: 0 + maximum: 4294967295 + tag: + description: Tag + type: integer + minimum: 1 + maximum: 4294967295 + local_preference: + description: Local preference + type: integer + minimum: 1 + maximum: 4294967295 + peer: + description: Peer + type: string + enum: + - local + - none + ipv4: + type: object + description: bgp-route-map-redistributions ipv4 object + properties: + address: + type: object + description: bgp-route-map-redistributions ipv4 object address + properties: + access_list: + description: Access list + type: string + prefix_list: + description: Prefix list + type: string + next_hop: + type: object + description: bgp-route-map-redistributions ipv4 object next_hop + properties: + access_list: + description: Access list + type: string + prefix_list: + description: Prefix list + type: string + route_source: + type: object + description: bgp-route-map-redistributions ipv4 object route_source + properties: + access_list: + description: Access list + type: string + prefix_list: + description: Prefix list + type: string + set: + type: object + properties: + metric: + type: object + properties: + value: + description: Metric value + type: integer + minimum: 0 + maximum: 4294967295 + action: + description: Metric action + type: string + enum: + - set + - add + - subtract + metric_type: + description: Metric type + type: string + enum: + - type-1 + - type-2 + tag: + description: Tag + type: integer + minimum: 1 + maximum: 4294967295 + - title: rib + required: + - rib + properties: + rib: + type: object + properties: + route_map: + description: Route maps + type: array + items: + type: object + properties: + name: + description: Sequence number + type: integer + minimum: 1 + maximum: 65535 + action: + description: Action + type: string + enum: + - permit + - deny + description: + description: Description + type: string + match: + type: object + properties: + as_path_access_list: + description: AS path access list + type: string + regular_community: + description: Regular community + type: string + large_community: + description: Large community + type: string + extended_community: + description: Extended community + type: string + interface: + description: Interface + type: string + origin: + description: Origin + type: string + metric: + description: Metric + type: integer + minimum: 0 + maximum: 4294967295 + tag: + description: Tag + type: integer + minimum: 1 + maximum: 4294967295 + local_preference: + description: Local preference + type: integer + minimum: 1 + maximum: 4294967295 + peer: + description: Peer + type: string + enum: + - local + - none + ipv4: + type: object + properties: + address: + type: object + description: bgp-route-map-redistributions ipv4 rib object address + properties: + access_list: + description: Access list + type: string + prefix_list: + description: Prefix list + type: string + next_hop: + type: object + description: bgp-route-map-redistributions ipv4 rib object next_hop + properties: + access_list: + description: Access list + type: string + prefix_list: + description: Prefix list + type: string + route_source: + type: object + properties: + access_list: + description: Access list + type: string + prefix_list: + description: Prefix list + type: string + set: + type: object + properties: + source_address: + description: Source address + type: string + - title: ospf + required: + - ospf + properties: + ospf: + type: object + oneOf: + - title: bgp + required: + - bgp + properties: + bgp: + type: object + properties: + route_map: + description: Route maps + type: array + items: + type: object + properties: + name: + description: Sequence number + type: integer + minimum: 1 + maximum: 65535 + action: + description: Action + type: string + enum: + - permit + - deny + description: + description: Description + type: string + match: + type: object + properties: + interface: + description: Interface + type: string + metric: + description: Metric + type: integer + minimum: 0 + maximum: 4294967295 + tag: + description: Tag + type: integer + minimum: 1 + maximum: 4294967295 + address: + type: object + description: bgp-route-map-redistributions ospf address + properties: + access_list: + description: Access list + type: string + prefix_list: + description: Prefix list + type: string + next_hop: + type: object + description: bgp-route-map-redistributions ospf next_hop + properties: + access_list: + description: Access list + type: string + prefix_list: + description: Prefix list + type: string + set: + type: object + properties: + atomic_aggregate: + description: Enable BGP atomic aggregate? + type: boolean + local_preference: + description: Local preference + type: integer + minimum: 0 + maximum: 4294967295 + tag: + description: Tag + type: integer + minimum: 1 + maximum: 4294967295 + metric: + type: object + properties: + action: + description: Metric action + type: string + enum: + - set + - add + - substract + value: + description: Metric value + type: integer + minimum: 0 + maximum: 4294967295 + weight: + description: Weight + type: integer + minimum: 0 + maximum: 4294967295 + origin: + description: Origin + type: string + enum: + - none + - egp + - igp + - incomplete + originator_id: + description: Originator ID + type: string + aggregator: + type: object + description: bgp-route-map-redistributions set aggregator + properties: + as: + description: Aggregator AS + type: integer + minimum: 1 + maximum: 4294967295 + router_id: + description: Router ID + type: string + ipv4: + type: object + properties: + source_address: + description: Source address + type: string + next_hop: + description: Next hop + type: string + aspath_prepend: + description: AS numbers + type: array + items: + description: AS number type: integer minimum: 1 - maximum: 4294967295 - router_id: - description: Router ID - type: string - ipv4: - type: object - properties: - source_address: - description: Source address + maximum: 65535 + regular_community: + description: Regular communities + type: array + items: + description: Regular community type: string - next_hop: - description: Next hop + large_community: + description: Large communities + type: array + items: + description: Large community type: string - aspath_prepend: - description: AS numbers - type: array - items: - description: AS number + - title: rib + required: + - rib + properties: + rib: + type: object + properties: + route_map: + description: Route maps + type: array + items: + type: object + properties: + name: + description: Sequence number + type: integer + minimum: 1 + maximum: 65535 + action: + description: Action + type: string + enum: + - permit + - deny + description: + description: Description + type: string + match: + type: object + properties: + interface: + description: Interface + type: string + metric: + description: Metric + type: integer + minimum: 0 + maximum: 4294967295 + tag: type: integer minimum: 1 - maximum: 65535 - regular_community: - description: Regular communities - type: array - items: - description: Regular community + maximum: 4294967295 + address: + type: object + properties: + access_list: + description: Access list + type: string + prefix_list: + description: Prefix list + type: string + next_hop: + type: object + properties: + access_list: + description: Access list + type: string + prefix_list: + description: Prefix list + type: string + set: + type: object + properties: + source_address: + description: Source address type: string - large_community: - description: Large communities - type: array - items: - description: Large community + - title: connected_static + required: + - connected_static + properties: + connected_static: + type: object + oneOf: + - title: bgp + required: + - bgp + properties: + bgp: + type: object + properties: + route_map: + description: Route maps + type: array + items: + type: object + properties: + name: + description: Sequence number + type: integer + minimum: 1 + maximum: 65535 + action: + description: Action + type: string + enum: + - permit + - deny + description: + description: Description + type: string + match: + type: object + properties: + interface: + description: Interface type: string - - title: rib - required: - - rib - properties: - rib: - type: object - properties: - route_map: - description: Route maps - type: array - items: - type: object - properties: - name: - description: Sequence number - type: integer - minimum: 1 - maximum: 65535 - action: - description: Action - type: string - enum: - - permit - - deny - description: - description: Description - type: string - match: - type: object - properties: - interface: - description: Interface - type: string - metric: - description: Metric - type: integer - minimum: 0 - maximum: 4294967295 - tag: - type: integer - minimum: 1 - maximum: 4294967295 - address: - type: object - properties: - access_list: - description: Access list - type: string - prefix_list: - description: Prefix list - type: string - next_hop: - type: object - properties: - access_list: - description: Access list - type: string - prefix_list: - description: Prefix list - type: string - set: - type: object - properties: - source_address: - description: Source address - type: string - - title: connected_static - required: - - connected_static - properties: - connected_static: - type: object - oneOf: - - title: bgp - required: - - bgp - properties: - bgp: - type: object - properties: - route_map: - description: Route maps - type: array - items: - type: object - properties: - name: - description: Sequence number - type: integer - minimum: 1 - maximum: 65535 - action: - description: Action - type: string - enum: - - permit - - deny - description: - description: Description - type: string - match: - type: object - properties: - interface: - description: Interface - type: string - metric: - description: Metric - type: integer - minimum: 0 - maximum: 4294967295 - ipv4: - type: object - properties: - address: - type: object - properties: - access_list: - description: Access list - type: string - prefix_list: - description: Prefix list - type: string - next_hop: - type: object - properties: - access_list: - description: Access list - type: string - prefix_list: - description: Prefix list - type: string - set: - type: object - properties: - atomic_aggregate: - description: Enable BGP atomic aggregate? - type: boolean - local_preference: - description: Local preference - type: integer - minimum: 0 - maximum: 4294967295 - tag: - description: Tag - type: integer - minimum: 1 - maximum: 4294967295 - metric: - type: object - properties: - action: - description: Metric action - type: string - enum: - - set - - add - - substract - value: - description: Metric value - type: integer - minimum: 0 - maximum: 4294967295 - weight: - description: Weight - type: integer - minimum: 0 - maximum: 4294967295 - origin: - description: Origin - type: string - enum: - - none - - egp - - igp - - incomplete - originator_id: - description: Originator ID - type: string - aggregator: - type: object - properties: - as: - description: Aggregator AS + metric: + description: Metric + type: integer + minimum: 0 + maximum: 4294967295 + ipv4: + type: object + description: bgp-route-map-redistributions connected-static ipv4 + properties: + address: + type: object + properties: + access_list: + description: Access list + type: string + prefix_list: + description: Prefix list + type: string + next_hop: + type: object + properties: + access_list: + description: Access list + type: string + prefix_list: + description: Prefix list + type: string + set: + type: object + properties: + atomic_aggregate: + description: Enable BGP atomic aggregate? + type: boolean + local_preference: + description: Local preference + type: integer + minimum: 0 + maximum: 4294967295 + tag: + description: Tag + type: integer + minimum: 1 + maximum: 4294967295 + metric: + type: object + properties: + action: + description: Metric action + type: string + enum: + - set + - add + - substract + value: + description: Metric value + type: integer + minimum: 0 + maximum: 4294967295 + weight: + description: Weight + type: integer + minimum: 0 + maximum: 4294967295 + origin: + description: Origin + type: string + enum: + - none + - egp + - igp + - incomplete + originator_id: + description: Originator ID + type: string + aggregator: + type: object + description: bgp-route-map-redistributions connected_static aggregator + properties: + as: + description: Aggregator AS + type: integer + minimum: 1 + maximum: 4294967295 + router_id: + description: Router ID + type: string + ipv4: + type: object + properties: + source_address: + description: Source address + type: string + next_hop: + description: Next hop + type: string + aspath_prepend: + description: AS numbers + type: array + items: + description: AS number type: integer minimum: 1 - maximum: 4294967295 - router_id: - description: Router ID - type: string - ipv4: - type: object - properties: - source_address: - description: Source address + maximum: 65535 + regular_community: + description: Regular communities + type: array + items: + description: Regular community type: string - next_hop: - description: Next hop + large_community: + description: Large communities + type: array + items: + description: Large community type: string - aspath_prepend: - description: AS numbers - type: array - items: - description: AS number + - title: ospf + required: + - ospf + properties: + ospf: + type: object + properties: + route_map: + description: Route maps + type: array + items: + type: object + properties: + name: + description: Sequence number + type: integer + minimum: 1 + maximum: 65535 + action: + description: Action + type: string + enum: + - permit + - deny + description: + description: Description + type: string + match: + type: object + properties: + interface: + description: Interface + type: string + metric: + description: Metric + type: integer + minimum: 0 + maximum: 4294967295 + ipv4: + type: object + description: bgp-route-map-redistributions connected-static match ipv4 + properties: + address: + type: object + properties: + access_list: + description: Access list + type: string + prefix_list: + description: Prefix list + type: string + next_hop: + type: object + properties: + access_list: + description: Access list + type: string + prefix_list: + description: Prefix list + type: string + set: + type: object + properties: + metric: + type: object + properties: + action: + description: Metric action + type: string + enum: + - set + - add + - substract + value: + description: Metric value + type: integer + minimum: 0 + maximum: 4294967295 + metric_type: + description: Metric type + type: string + enum: + - type-1 + - type-2 + tag: + description: Tag type: integer minimum: 1 - maximum: 65535 - regular_community: - description: Regular communities - type: array - items: - description: Regular community + maximum: 4294967295 + - title: rib + required: + - rib + properties: + rib: + type: object + properties: + route_map: + description: Route maps + type: array + items: + type: object + properties: + name: + description: Sequence number + type: integer + minimum: 1 + maximum: 65535 + action: + description: Action + type: string + enum: + - permit + - deny + description: + description: Description + type: string + match: + type: object + properties: + interface: + description: Interface type: string - large_community: - description: Large communities - type: array - items: - description: Large community + metric: + description: Metric + type: integer + minimum: 0 + maximum: 4294967295 + ipv4: + type: object + properties: + address: + type: object + properties: + access_list: + description: Access list + type: string + prefix_list: + description: Prefix list + type: string + next_hop: + type: object + properties: + access_list: + description: Access list + type: string + prefix_list: + description: Prefix list + type: string + set: + type: object + properties: + source_address: + description: Source address type: string - - title: ospf - required: - - ospf - properties: - ospf: - type: object - properties: - route_map: - description: Route maps - type: array - items: - type: object - properties: - name: - description: Sequence number - type: integer - minimum: 1 - maximum: 65535 - action: - description: Action - type: string - enum: - - permit - - deny - description: - description: Description - type: string - match: - type: object - properties: - interface: - description: Interface - type: string - metric: - description: Metric - type: integer - minimum: 0 - maximum: 4294967295 - ipv4: - type: object - properties: - address: - type: object - properties: - access_list: - description: Access list - type: string - prefix_list: - description: Prefix list - type: string - next_hop: - type: object - properties: - access_list: - description: Access list - type: string - prefix_list: - description: Prefix list - type: string - set: - type: object - properties: - metric: - type: object - properties: - action: - description: Metric action - type: string - enum: - - set - - add - - substract - value: - description: Metric value - type: integer - minimum: 0 - maximum: 4294967295 - metric_type: - description: Metric type - type: string - enum: - - type-1 - - type-2 - tag: - description: Tag - type: integer - minimum: 1 - maximum: 4294967295 - - title: rib - required: - - rib - properties: - rib: - type: object - properties: - route_map: - description: Route maps - type: array - items: - type: object - properties: - name: - description: Sequence number - type: integer - minimum: 1 - maximum: 65535 - action: - description: Action - type: string - enum: - - permit - - deny - description: - description: Description - type: string - match: - type: object - properties: - interface: - description: Interface - type: string - metric: - description: Metric - type: integer - minimum: 0 - maximum: 4294967295 - ipv4: - type: object - properties: - address: - type: object - properties: - access_list: - description: Access list - type: string - prefix_list: - description: Prefix list - type: string - next_hop: - type: object - properties: - access_list: - description: Access list - type: string - prefix_list: - description: Prefix list - type: string - set: - type: object - properties: - source_address: - description: Source address - type: string - - oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + - oneOf: + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device bgp-route-maps: type: object required: @@ -11348,8 +11499,8 @@ components: description: Action type: string enum: - - permit - - deny + - permit + - deny match: type: object properties: @@ -11389,10 +11540,11 @@ components: description: Peer type: string enum: - - local - - none + - local + - none ipv4: type: object + description: bgp-route-maps ipv4 object properties: address: type: object @@ -11444,9 +11596,9 @@ components: description: Metric action type: string enum: - - set - - add - - substract + - set + - add + - substract value: description: Metric value type: integer @@ -11461,10 +11613,10 @@ components: description: Origin type: string enum: - - none - - egp - - igp - - incomplete + - none + - egp + - igp + - incomplete remove_regular_community: description: Remove regular community name type: string @@ -11476,6 +11628,7 @@ components: type: string aggregator: type: object + description: bgp-route-maps aggregator properties: as: description: Aggregator AS @@ -11533,44 +11686,43 @@ components: description: Overwrite large community? type: boolean oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device link-tags: type: object required: - - name + - name properties: id: type: string @@ -11631,39 +11783,39 @@ components: type: string maxLength: 0 oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device logical-routers: type: object required: @@ -11674,1580 +11826,1580 @@ components: description: UUID of the resource readOnly: true example: 123e4567-e89b-12d3-a456-426655440000 - name: + name: type: string - routing_stack: + routing_stack: type: string enum: - legacy - advanced - vrf: + vrf: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - interface: + interface: type: array - items: + items: type: string - global_vrid: + global_vrid: type: number - zone_name: + zone_name: type: string - admin_dists: + admin_dists: type: object - properties: - static: + properties: + static: type: number - static_ipv6: + static_ipv6: type: number - ospf_inter: + ospf_inter: type: number - ospf_intra: + ospf_intra: type: number - ospf_ext: + ospf_ext: type: number - ospfv3_inter: + ospfv3_inter: type: number - ospfv3_intra: + ospfv3_intra: type: number - ospfv3_ext: + ospfv3_ext: type: number - bgp_internal: + bgp_internal: type: number - bgp_external: + bgp_external: type: number - bgp_local: + bgp_local: type: number - rip: + rip: type: number - vr_admin_dists: + vr_admin_dists: type: object - properties: - static: + properties: + static: type: number - static_ipv6: + static_ipv6: type: number - ospf_int: + ospf_int: type: number - ospf_ext: + ospf_ext: type: number - ospfv3_int: + ospfv3_int: type: number - ospfv3_ext: + ospfv3_ext: type: number - ibgp: + ibgp: type: number - ebgp: + ebgp: type: number - rip: + rip: type: number - sdwan_type: + sdwan_type: type: string - rib_filter: + rib_filter: type: object - properties: - ipv4: + properties: + ipv4: type: object - properties: - static: + properties: + static: type: object - properties: - route_map: + properties: + route_map: type: string - bgp: + bgp: type: object - properties: - route_map: + properties: + route_map: type: string - ospf: + ospf: type: object - properties: - route_map: + properties: + route_map: type: string - rip: + rip: type: object - properties: - route_map: + properties: + route_map: type: string - ipv6: + ipv6: type: object - properties: - static: + properties: + static: type: object - properties: - route_map: + properties: + route_map: type: string - bgp: + bgp: type: object - properties: - route_map: + properties: + route_map: type: string - ospfv3: + ospfv3: type: object - properties: - route_map: + properties: + route_map: type: string - routing_table: + routing_table: type: object - properties: - ip: + properties: + ip: type: object - properties: - static_route: + properties: + static_route: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - destination: + destination: type: string - interface: + interface: type: string - nexthop: + nexthop: type: object oneOf: - - title: receive - required: - - receive - properties: - receive: - type: object - properties: {} - - title: discard - required: - - discard - properties: - discard: - type: object - properties: {} - - title: ipv6_address - required: - - ipv6_address - properties: - ipv6_address: - type: string - - title: fqdn - required: - - fqdn - properties: - fqdn: - type: string - - title: next_lr - required: - - next_lr - properties: - next_lr: - type: string - - title: next_vr - required: - - next_vr - properties: - next_vr: - type: string - - title: tunnel - required: - - tunnel - properties: - tunnel: - type: string - route_table: + - title: receive + required: + - receive + properties: + receive: + type: object + properties: {} + - title: discard + required: + - discard + properties: + discard: + type: object + properties: {} + - title: ipv6_address + required: + - ipv6_address + properties: + ipv6_address: + type: string + - title: fqdn + required: + - fqdn + properties: + fqdn: + type: string + - title: next_lr + required: + - next_lr + properties: + next_lr: + type: string + - title: next_vr + required: + - next_vr + properties: + next_vr: + type: string + - title: tunnel + required: + - tunnel + properties: + tunnel: + type: string + route_table: type: object oneOf: - - title: unicast - required: - - unicast - properties: - unicast: - type: object - properties: {} - - title: multicast - required: - - multicast - properties: - multicast: - type: object - properties: {} - - title: both - required: - - both - properties: - both: - type: object - properties: {} - - title: no_install - required: - - no_install - properties: - no_install: - type: object - properties: {} - admin_dist: + - title: unicast + required: + - unicast + properties: + unicast: + type: object + properties: {} + - title: multicast + required: + - multicast + properties: + multicast: + type: object + properties: {} + - title: both + required: + - both + properties: + both: + type: object + properties: {} + - title: no_install + required: + - no_install + properties: + no_install: + type: object + properties: {} + admin_dist: type: number - metric: + metric: type: number - bfd: + bfd: type: object - properties: - profile: + properties: + profile: type: string - path_monitor: + path_monitor: type: object - properties: - enable: + properties: + enable: type: boolean - failure_condition: + failure_condition: type: string enum: - 'any' - 'all' - hold_time: + hold_time: type: number - monitor_destinations: + monitor_destinations: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - enable: + enable: type: boolean - source: + source: type: string - destination: + destination: type: string - destination_fqdn: + destination_fqdn: type: string - interval: + interval: type: number - count: + count: type: number - ipv6: + ipv6: type: object - properties: - static_route: + properties: + static_route: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - destination: + destination: type: string - interface: + interface: type: string - nexthop: + nexthop: type: object oneOf: - - title: receive - required: - - receive - properties: - receive: - type: object - properties: {} - - title: discard - required: - - discard - properties: - discard: - type: object - properties: {} - - title: ipv6_address - required: - - ipv6_address - properties: - ipv6_address: - type: string - - title: fqdn - required: - - fqdn - properties: - fqdn: - type: string - - title: next_lr - required: - - next_lr - properties: - next_lr: - type: string - - title: next_vr - required: - - next_vr - properties: - next_vr: - type: string - - title: tunnel - required: - - tunnel - properties: - tunnel: - type: string - admin_dist: + - title: receive + required: + - receive + properties: + receive: + type: object + properties: {} + - title: discard + required: + - discard + properties: + discard: + type: object + properties: {} + - title: ipv6_address + required: + - ipv6_address + properties: + ipv6_address: + type: string + - title: fqdn + required: + - fqdn + properties: + fqdn: + type: string + - title: next_lr + required: + - next_lr + properties: + next_lr: + type: string + - title: next_vr + required: + - next_vr + properties: + next_vr: + type: string + - title: tunnel + required: + - tunnel + properties: + tunnel: + type: string + admin_dist: type: number - metric: + metric: type: number - option: + option: type: object - properties: - passive: + properties: + passive: type: object properties: {} - route_table: + route_table: type: object - properties: - unicast: + properties: + unicast: type: object - properties: {} - multicast: + properties: {} + multicast: type: object - properties: {} - both: + properties: {} + both: type: object - properties: {} - no_install: + properties: {} + no_install: type: object properties: {} - bfd: + bfd: type: object - properties: - profile: + properties: + profile: type: string - path_monitor: + path_monitor: type: object - properties: - enable: + properties: + enable: type: boolean - failure_condition: + failure_condition: type: string enum: - 'any' - 'all' - hold_time: + hold_time: type: number - monitor_destinations: + monitor_destinations: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - enable: + enable: type: boolean - source: + source: type: string - destination: + destination: type: string - destination_fqdn: + destination_fqdn: type: string - interval: + interval: type: number - count: + count: type: number - ospf: + ospf: type: object - properties: - router_id: + properties: + router_id: type: string - global_bfd: + global_bfd: type: object - properties: - profile: + properties: + profile: type: string - enable: + enable: type: boolean - rfc1583: + rfc1583: type: boolean - reject_default_route: + reject_default_route: type: boolean - allow_redist_default_route: + allow_redist_default_route: type: boolean - flood_prevention: + flood_prevention: type: object - properties: - hello: + properties: + hello: type: object - properties: - enable: + properties: + enable: type: boolean - max_packet: + max_packet: type: number - lsa: + lsa: type: object - properties: - enable: + properties: + enable: type: boolean - max_packet: + max_packet: type: number - spf_timer: + spf_timer: type: string - global_if_timer: + global_if_timer: type: string - vr_timers: + vr_timers: type: object - properties: - spf_calculation_delay: + properties: + spf_calculation_delay: type: number - lsa_interval: + lsa_interval: type: number - auth_profile: + auth_profile: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string oneOf: - - title: password - required: - - password - properties: - password: - type: string - - title: md5 - required: - - md5 - properties: - md5: - type: array - items: - type: object - required: - - 'name' - properties: - name: - type: number - key: - type: string - preferred: - type: boolean - redistribution_profile: + - title: password + required: + - password + properties: + password: + type: string + - title: md5 + required: + - md5 + properties: + md5: + type: array + items: + type: object + required: + - 'name' + properties: + name: + type: number + key: + type: string + preferred: + type: boolean + redistribution_profile: type: string - area: + area: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - authentication: + authentication: type: string type: type: object oneOf: - - title: normal - required: - - normal - properties: - normal: - type: object - properties: - abr: - type: object - properties: - import_list: - type: string - export_list: - type: string - inbound_filter_list: - type: string - outbound_filter_list: - type: string - - title: stub - required: - - stub - properties: - stub: - type: object - properties: - no_summary: - type: boolean - accept_summary: - type: boolean - default_route: - type: object - oneOf: - - title: disable - required: - - disable + - title: normal + required: + - normal + properties: + normal: + type: object + properties: + abr: + type: object properties: - disable: - type: object - properties: {} - - title: advertise - required: - - advertise - properties: - advertise: - type: object - properties: - metric: - type: number - default_route_metric: - type: number - abr: - type: object - properties: - import_list: - type: string - export_list: - type: string - inbound_filter_list: - type: string - outbound_filter_list: - type: string - - title: nssa - required: - - nssa - properties: - nssa: - type: object - properties: - no_summary: - type: boolean - accept_summary: - type: boolean - default_information_originate: - type: object - properties: - metric: - type: number - metric_type: - type: string - enum: - - 'type-1' - - 'type-2' - default_route: - type: object - oneOf: - - title: disable - required: - - disable - properties: - disable: - type: object - properties: {} - - title: advertise - required: - - advertise - properties: - advertise: - type: object - properties: - metric: - type: number - type: - type: string - enum: - - 'ext-1' - - 'ext-2' - nssa_ext_range: - type: array - items: + import_list: + type: string + export_list: + type: string + inbound_filter_list: + type: string + outbound_filter_list: + type: string + - title: stub + required: + - stub + properties: + stub: + type: object + properties: + no_summary: + type: boolean + accept_summary: + type: boolean + default_route: + type: object + oneOf: + - title: disable + required: + - disable + properties: + disable: + type: object + properties: {} + - title: advertise + required: + - advertise + properties: + advertise: + type: object + properties: + metric: + type: number + default_route_metric: + type: number + abr: + type: object + properties: + import_list: + type: string + export_list: + type: string + inbound_filter_list: + type: string + outbound_filter_list: + type: string + - title: nssa + required: + - nssa + properties: + nssa: + type: object + properties: + no_summary: + type: boolean + accept_summary: + type: boolean + default_information_originate: type: object - required: - - 'name' - properties: - name: + properties: + metric: + type: number + metric_type: type: string + enum: + - 'type-1' + - 'type-2' + default_route: + type: object oneOf: - - title: advertise - required: - - advertise - properties: - advertise: - type: object - properties: {} - - title: suppress + - title: disable + required: + - disable + properties: + disable: + type: object + properties: {} + - title: advertise + required: + - advertise + properties: + advertise: + type: object + properties: + metric: + type: number + type: + type: string + enum: + - 'ext-1' + - 'ext-2' + nssa_ext_range: + type: array + items: + type: object required: - - suppress - properties: - suppress: + - 'name' + properties: + name: + type: string + oneOf: + - title: advertise + required: + - advertise + properties: + advertise: + type: object + properties: {} + - title: suppress + required: + - suppress + properties: + suppress: + type: object + properties: {} + abr: + type: object + properties: + import_list: + type: string + export_list: + type: string + inbound_filter_list: + type: string + outbound_filter_list: + type: string + nssa_ext_range: + type: array + items: type: object - properties: {} - abr: - type: object - properties: - import_list: - type: string - export_list: - type: string - inbound_filter_list: - type: string - outbound_filter_list: - type: string - nssa_ext_range: - type: array - items: - type: object - required: - - 'name' - properties: - name: - type: string - route_tag: - type: number - advertise: - type: boolean - range: + required: + - 'name' + properties: + name: + type: string + route_tag: + type: number + advertise: + type: boolean + range: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - substitute: + substitute: type: string - advertise: + advertise: type: boolean - vr_range: + vr_range: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string oneOf: - - title: advertise - required: - - advertise - properties: - advertise: - type: object - properties: {} - - title: suppress - required: - - suppress - properties: - suppress: - type: object - properties: {} - interface: + - title: advertise + required: + - advertise + properties: + advertise: + type: object + properties: {} + - title: suppress + required: + - suppress + properties: + suppress: + type: object + properties: {} + interface: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - enable: + enable: type: boolean - mtu_ignore: + mtu_ignore: type: boolean - passive: + passive: type: boolean - priority: + priority: type: number - link_type: + link_type: type: object oneOf: - - title: broadcast - required: - - broadcast - properties: - broadcast: - type: object - properties: {} - - title: p2p - required: - - p2p - properties: - p2p: - type: object - properties: {} - - title: p2mp - required: - - p2mp - properties: - p2mp: - type: object - properties: - neighbor: - type: array - items: - type: object - required: - - 'name' - properties: - name: - type: string - priority: - type: number - metric: + - title: broadcast + required: + - broadcast + properties: + broadcast: + type: object + properties: {} + - title: p2p + required: + - p2p + properties: + p2p: + type: object + properties: {} + - title: p2mp + required: + - p2mp + properties: + p2mp: + type: object + properties: + neighbor: + type: array + items: + type: object + required: + - 'name' + properties: + name: + type: string + priority: + type: number + metric: type: number - authentication: + authentication: type: string - bfd: + bfd: type: object - properties: - profile: + properties: + profile: type: string - timing: + timing: type: string - vr_timing: + vr_timing: type: object - properties: - hello_interval: + properties: + hello_interval: type: number - dead_counts: + dead_counts: type: number - retransmit_interval: + retransmit_interval: type: number - transit_delay: + transit_delay: type: number - gr_delay: + gr_delay: type: number - virtual_link: + virtual_link: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - neighbor_id: + neighbor_id: type: string - transit_area_id: + transit_area_id: type: string - enable: + enable: type: boolean - interface_id: + interface_id: type: number - instance_id: + instance_id: type: number - timing: + timing: type: string - vr_timing: + vr_timing: type: object - properties: - hello_interval: + properties: + hello_interval: type: number - dead_counts: + dead_counts: type: number - retransmit_interval: + retransmit_interval: type: number - transit_delay: + transit_delay: type: number - passive: + passive: type: boolean - authentication: + authentication: type: string - bfd: + bfd: type: object - properties: - profile: + properties: + profile: type: string - export_rules: + export_rules: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - new_path_type: + new_path_type: type: string enum: - 'ext-1' - 'ext-2' - new_tag: + new_tag: type: string - metric: + metric: type: number - graceful_restart: + graceful_restart: type: object - properties: - enable: + properties: + enable: type: boolean - grace_period: + grace_period: type: number - helper_enable: + helper_enable: type: boolean - strict_LSA_checking: + strict_LSA_checking: type: boolean - max_neighbor_restart_time: + max_neighbor_restart_time: type: number - ospfv3: + ospfv3: type: object - properties: - enable: + properties: + enable: type: boolean - reject_default_route: + reject_default_route: type: boolean - allow_redist_default_route: + allow_redist_default_route: type: boolean - router_id: + router_id: type: string - global_bfd: + global_bfd: type: object - properties: - profile: + properties: + profile: type: string - disable_transit_traffic: + disable_transit_traffic: type: boolean - vr_timers: + vr_timers: type: object - properties: - spf_calculation_delay: + properties: + spf_calculation_delay: type: number - lsa_interval: + lsa_interval: type: number - auth_profile: + auth_profile: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - spi: + spi: type: string oneOf: - - title: esp - required: - - esp - properties: - esp: - type: object - properties: - authentication: - type: object - oneOf: + - title: esp + required: + - esp + properties: + esp: + type: object + properties: + authentication: + type: object + oneOf: + - title: sha1 + required: + - sha1 + properties: + sha1: + type: object + properties: + key: + type: string + - title: sha256 + required: + - sha256 + properties: + sha256: + type: object + properties: + key: + type: string + - title: sha384 + required: + - sha384 + properties: + sha384: + type: object + properties: + key: + type: string + - title: sha512 + required: + - sha512 + properties: + sha512: + type: object + properties: + key: + type: string + - title: md5 + required: + - md5 + properties: + md5: + type: object + properties: + key: + type: string + - title: none + required: + - none + properties: + none: + type: object + properties: {} + encryption: + type: object + properties: + algorithm: + type: string + enum: + - '3des' + - 'aes-128-cbc' + - 'aes-192-cbc' + - 'aes-256-cbc' + - 'null' + key: + type: string + - title: ah + required: + - ah + properties: + ah: + type: object + oneOf: - title: sha1 required: - - sha1 - properties: - sha1: + - sha1 + properties: + sha1: type: object - properties: - key: + properties: + key: type: string - title: sha256 required: - - sha256 - properties: - sha256: + - sha256 + properties: + sha256: type: object - properties: - key: + properties: + key: type: string - title: sha384 required: - - sha384 - properties: - sha384: + - sha384 + properties: + sha384: type: object - properties: - key: + properties: + key: type: string - title: sha512 required: - - sha512 - properties: - sha512: + - sha512 + properties: + sha512: type: object - properties: - key: + properties: + key: type: string - title: md5 required: - - md5 - properties: - md5: + - md5 + properties: + md5: type: object - properties: - key: + properties: + key: type: string - - title: none - required: - - none - properties: - none: - type: object - properties: {} - encryption: - type: object - properties: - algorithm: - type: string - enum: - - '3des' - - 'aes-128-cbc' - - 'aes-192-cbc' - - 'aes-256-cbc' - - 'null' - key: - type: string - - title: ah - required: - - ah - properties: - ah: - type: object - oneOf: - - title: sha1 - required: - - sha1 - properties: - sha1: - type: object - properties: - key: - type: string - - title: sha256 - required: - - sha256 - properties: - sha256: - type: object - properties: - key: - type: string - - title: sha384 - required: - - sha384 - properties: - sha384: - type: object - properties: - key: - type: string - - title: sha512 - required: - - sha512 - properties: - sha512: - type: object - properties: - key: - type: string - - title: md5 - required: - - md5 - properties: - md5: - type: object - properties: - key: - type: string - spf_timer: + spf_timer: type: string - global_if_timer: + global_if_timer: type: string - redistribution_profile: + redistribution_profile: type: string - area: + area: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - authentication: + authentication: type: string - type: + type: type: object oneOf: - - title: normal - required: - - normal - properties: - normal: - type: object - properties: - abr: - type: object - properties: - import_list: - type: string - export_list: - type: string - inbound_filter_list: - type: string - outbound_filter_list: - type: string - - title: stub - required: - - stub - properties: - stub: - type: object - properties: - accept_summary: - type: boolean - default_route: - type: object - oneOf: - - title: disable - required: - - disable - properties: - disable: - type: object - properties: {} - - title: advertise - required: - - advertise - properties: - advertise: - type: object - properties: - metric: - type: number - no_summary: - type: boolean - default_route_metric: - type: number - abr: - type: object - properties: - import_list: - type: string - export_list: - type: string - inbound_filter_list: - type: string - outbound_filter_list: - type: string - - title: nssa - required: - - nssa - properties: - nssa: - type: object - properties: - nssa_ext_range: - type: array - items: + - title: normal + required: + - normal + properties: + normal: + type: object + properties: + abr: + type: object + properties: + import_list: + type: string + export_list: + type: string + inbound_filter_list: + type: string + outbound_filter_list: + type: string + - title: stub + required: + - stub + properties: + stub: + type: object + properties: + accept_summary: + type: boolean + default_route: + type: object + oneOf: + - title: disable + required: + - disable + properties: + disable: + type: object + properties: {} + - title: advertise + required: + - advertise + properties: + advertise: + type: object + properties: + metric: + type: number + no_summary: + type: boolean + default_route_metric: + type: number + abr: type: object - required: - - 'name' - properties: - name: + properties: + import_list: type: string - route_tag: - type: number - oneOf: - - title: advertise - required: - - advertise - properties: - advertise: - type: object - properties: {} - - title: suppress + export_list: + type: string + inbound_filter_list: + type: string + outbound_filter_list: + type: string + - title: nssa + required: + - nssa + properties: + nssa: + type: object + properties: + nssa_ext_range: + type: array + items: + type: object required: - - suppress - properties: - suppress: - type: object - properties: {} - no_summary: - type: boolean - default_information_originate: - type: object - properties: - metric: - type: number - metric_type: - type: string - enum: - - 'type-1' - - 'type-2' - accept_summary: - type: boolean - default_route: - type: object - oneOf: - - title: disable - required: - - disable - properties: - disable: - type: object - properties: {} - - title: advertise - required: - - advertise - properties: - advertise: - type: object - properties: - metric: - type: number - type: - type: string - enum: - - 'ext-1' - - 'ext-2' - abr: - type: object - properties: - import_list: - type: string - export_list: - type: string - inbound_filter_list: - type: string - outbound_filter_list: - type: string - nssa_ext_range: - type: array - items: - type: object - required: - - 'name' - properties: - name: - type: string - route_tag: - type: number - oneOf: + - 'name' + properties: + name: + type: string + route_tag: + type: number + oneOf: - title: advertise required: - - advertise - properties: - advertise: + - advertise + properties: + advertise: type: object properties: {} - title: suppress required: - - suppress - properties: - suppress: + - suppress + properties: + suppress: type: object properties: {} - range: + no_summary: + type: boolean + default_information_originate: + type: object + properties: + metric: + type: number + metric_type: + type: string + enum: + - 'type-1' + - 'type-2' + accept_summary: + type: boolean + default_route: + type: object + oneOf: + - title: disable + required: + - disable + properties: + disable: + type: object + properties: {} + - title: advertise + required: + - advertise + properties: + advertise: + type: object + properties: + metric: + type: number + type: + type: string + enum: + - 'ext-1' + - 'ext-2' + abr: + type: object + properties: + import_list: + type: string + export_list: + type: string + inbound_filter_list: + type: string + outbound_filter_list: + type: string + nssa_ext_range: + type: array + items: + type: object + required: + - 'name' + properties: + name: + type: string + route_tag: + type: number + oneOf: + - title: advertise + required: + - advertise + properties: + advertise: + type: object + properties: {} + - title: suppress + required: + - suppress + properties: + suppress: + type: object + properties: {} + range: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - advertise: + advertise: type: boolean - vr_range: + vr_range: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string oneOf: - - title: advertise - required: - - advertise - properties: - advertise: - type: object - properties: {} - - title: suppress - required: - - suppress - properties: - suppress: - type: object - properties: {} - interface: + - title: advertise + required: + - advertise + properties: + advertise: + type: object + properties: {} + - title: suppress + required: + - suppress + properties: + suppress: + type: object + properties: {} + interface: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - enable: + enable: type: boolean - mtu_ignore: + mtu_ignore: type: boolean - passive: + passive: type: boolean - priority: + priority: type: number - link_type: + link_type: type: object oneOf: - - title: broadcast - required: - - broadcast - properties: - broadcast: - type: object - properties: {} - - title: p2p - required: - - p2p - properties: - p2p: - type: object - properties: {} - - title: p2mp - required: - - p2mp - properties: - p2mp: - type: object - properties: - neighbor: - type: array - items: - type: object - required: - - 'name' - properties: - name: - type: string - priority: - type: number - neighbor: + - title: broadcast + required: + - broadcast + properties: + broadcast: + type: object + properties: {} + - title: p2p + required: + - p2p + properties: + p2p: + type: object + properties: {} + - title: p2mp + required: + - p2mp + properties: + p2mp: + type: object + properties: + neighbor: + type: array + items: + type: object + required: + - 'name' + properties: + name: + type: string + priority: + type: number + neighbor: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - vr_timing: + vr_timing: type: object - properties: - hello_interval: + properties: + hello_interval: type: number - dead_counts: + dead_counts: type: number - retransmit_interval: + retransmit_interval: type: number - transit_delay: + transit_delay: type: number - gr_delay: + gr_delay: type: number - metric: + metric: type: number - instance_id: + instance_id: type: number - authentication: + authentication: type: string - bfd: + bfd: type: object - properties: - profile: + properties: + profile: type: string - timing: + timing: type: string - virtual_link: + virtual_link: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - neighbor_id: + neighbor_id: type: string - transit_area_id: + transit_area_id: type: string - enable: + enable: type: boolean - interface_id: + interface_id: type: number - instance_id: + instance_id: type: number - timing: + timing: type: string - vr_timing: + vr_timing: type: object - properties: - hello_interval: + properties: + hello_interval: type: number - dead_counts: + dead_counts: type: number - retransmit_interval: + retransmit_interval: type: number - transit_delay: + transit_delay: type: number - passive: + passive: type: boolean - authentication: + authentication: type: string - bfd: + bfd: type: object - properties: - profile: + properties: + profile: type: string - export_rules: + export_rules: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - new_path_type: + new_path_type: type: string enum: - 'ext-1' - 'ext-2' - new_tag: + new_tag: type: string - metric: + metric: type: number - graceful_restart: + graceful_restart: type: object - properties: - enable: + properties: + enable: type: boolean - grace_period: + grace_period: type: number - helper_enable: + helper_enable: type: boolean - strict_LSA_checking: + strict_LSA_checking: type: boolean - max_neighbor_restart_time: + max_neighbor_restart_time: type: number - ecmp: + ecmp: type: object - properties: - enable: + properties: + enable: type: boolean - algorithm: + algorithm: type: object oneOf: - - title: ip_modulo - required: - - ip_modulo - properties: - ip_modulo: - type: object - properties: {} - - title: ip_hash - required: - - ip_hash - properties: - ip_hash: - type: object - properties: - src_only: - type: boolean - use_port: - type: boolean - hash_seed: - type: number - - title: weighted_round_robin - required: - - weighted_round_robin - properties: - weighted_round_robin: - type: object - properties: - interface: - type: array - items: - type: object - required: - - 'name' - properties: - name: - type: string - weight: - type: number - - title: balanced_round_robin - required: - - balanced_round_robin - properties: - balanced_round_robin: - type: object - properties: {} - max_path: + - title: ip_modulo + required: + - ip_modulo + properties: + ip_modulo: + type: object + properties: {} + - title: ip_hash + required: + - ip_hash + properties: + ip_hash: + type: object + properties: + src_only: + type: boolean + use_port: + type: boolean + hash_seed: + type: number + - title: weighted_round_robin + required: + - weighted_round_robin + properties: + weighted_round_robin: + type: object + properties: + interface: + type: array + items: + type: object + required: + - 'name' + properties: + name: + type: string + weight: + type: number + - title: balanced_round_robin + required: + - balanced_round_robin + properties: + balanced_round_robin: + type: object + properties: {} + max_path: type: number - symmetric_return: + symmetric_return: type: boolean - strict_source_path: + strict_source_path: type: boolean - multicast: + multicast: type: object - properties: - enable: + properties: + enable: type: boolean - enable_v6: + enable_v6: type: boolean - static_route: + static_route: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - destination: + destination: type: string - interface: + interface: type: string - nexthop: + nexthop: type: object - properties: - ip_address: + properties: + ip_address: type: string - preference: + preference: type: number - pim: + pim: type: object - properties: - enable: + properties: + enable: type: boolean - rpf_lookup_mode: + rpf_lookup_mode: type: string enum: - 'mrib-then-urib' - 'mrib-only' - 'urib-only' - route_ageout_time: + route_ageout_time: type: number - if_timer_global: + if_timer_global: type: string - group_permission: + group_permission: type: string - ssm_address_space: + ssm_address_space: type: object - properties: - group_list: + properties: + group_list: type: string - spt_threshold: + spt_threshold: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - threshold: + threshold: type: string - interface: + interface: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - description: + description: type: string - dr_priority: + dr_priority: type: number - send_bsm: + send_bsm: type: boolean - if_timer: + if_timer: type: string - neighbor_filter: + neighbor_filter: type: string - rp: + rp: type: object - properties: - local_rp: + properties: + local_rp: type: object oneOf: - - title: static_rp - required: - - static_rp - properties: - static_rp: - type: object - properties: - interface: - type: string - address: - type: string - override: - type: boolean - group_list: - type: string - - title: candidate_rp - required: - - candidate_rp - properties: - candidate_rp: - type: object - properties: - interface: - type: string - address: - type: string - priority: - type: number - advertisement_interval: - type: number - group_list: - type: string - external_rp: + - title: static_rp + required: + - static_rp + properties: + static_rp: + type: object + properties: + interface: + type: string + address: + type: string + override: + type: boolean + group_list: + type: string + - title: candidate_rp + required: + - candidate_rp + properties: + candidate_rp: + type: object + properties: + interface: + type: string + address: + type: string + priority: + type: number + advertisement_interval: + type: number + group_list: + type: string + external_rp: type: array - items: + items: type: object - properties: - name: + properties: + name: type: string - group_list: + group_list: type: string - override: + override: type: boolean - igmp: + igmp: type: object - properties: - enable: + properties: + enable: type: boolean - dynamic: + dynamic: type: object - properties: - interface: + properties: + interface: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - version: + version: type: string enum: - '2' - '3' - robustness: + robustness: type: string enum: - '1' @@ -13257,168 +13409,168 @@ components: - '5' - '6' - '7' - group_filter: + group_filter: type: string - max_groups: + max_groups: type: string - max_sources: + max_sources: type: string - query_profile: + query_profile: type: string - router_alert_policing: + router_alert_policing: type: boolean - static: + static: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - interface: + interface: type: string - group_address: + group_address: type: string - source_address: + source_address: type: string - msdp: + msdp: type: object - properties: - enable: + properties: + enable: type: boolean - global_timer: + global_timer: type: string - global_authentication: + global_authentication: type: string - originator_id: + originator_id: type: object - properties: - interface: + properties: + interface: type: string - ip: + ip: type: string - peer: + peer: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - enable: + enable: type: boolean - local_address: + local_address: type: object - properties: - interface: + properties: + interface: type: string - ip: + ip: type: string - peer_as: + peer_as: type: string - peer_address: + peer_address: type: object oneOf: - - title: ip - required: - - ip - properties: - ip: - type: string - - title: fqdn - required: - - fqdn - properties: - fqdn: - type: string - authentication: + - title: ip + required: + - ip + properties: + ip: + type: string + - title: fqdn + required: + - fqdn + properties: + fqdn: + type: string + authentication: type: string - max_sa: + max_sa: type: number - inbound_sa_filter: + inbound_sa_filter: type: string - outbound_sa_filter: + outbound_sa_filter: type: string - mode: + mode: type: string enum: - PIM-SM - IGMP-Proxy - route_ageout_time: + route_ageout_time: type: number - interface_group: + interface_group: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - description: + description: type: string - interface: + interface: type: array - items: + items: type: string - group_permission: + group_permission: type: object - properties: - any_source_multicast: + properties: + any_source_multicast: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - group_address: + group_address: type: string - included: + included: type: boolean - source_specific_multicast: + source_specific_multicast: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - group_address: + group_address: type: string - source_address: + source_address: type: string - included: + included: type: boolean - igmp: + igmp: type: object - properties: - enable: + properties: + enable: type: boolean - version: + version: type: string enum: - '1' - '2' - '3' - mode: + mode: type: string enum: - 'router' - 'host' - max_query_response_time: + max_query_response_time: type: number - query_interval: + query_interval: type: number - last_member_query_interval: + last_member_query_interval: type: number - immediate_leave: + immediate_leave: type: boolean - robustness: + robustness: type: string enum: - '1' @@ -13428,1462 +13580,1462 @@ components: - '5' - '6' - '7' - max_groups: + max_groups: type: string - max_sources: + max_sources: type: string - router_alert_policing: + router_alert_policing: type: boolean - pim: + pim: type: object - properties: - enable: + properties: + enable: type: boolean - assert_interval: + assert_interval: type: number - hello_interval: + hello_interval: type: number - join_prune_interval: + join_prune_interval: type: number - dr_priority: + dr_priority: type: number - bsr_border: + bsr_border: type: boolean - allowed_neighbors: + allowed_neighbors: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - ssm_address_space: + ssm_address_space: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - group_address: + group_address: type: string - included: + included: type: boolean - spt_threshold: + spt_threshold: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - threshold: + threshold: type: string - rp: + rp: type: object - properties: - local_rp: + properties: + local_rp: type: object oneOf: - - title: static_rp - required: - - static_rp - properties: - static_rp: - type: object - properties: - interface: - type: string - address: - type: string - override: - type: boolean - group_addresses: - type: array - items: - type: string - - title: candidate_rp - required: - - candidate_rp - properties: - candidate_rp: - type: object - properties: - interface: - type: string - address: - type: string - priority: - type: number - advertisement_interval: - type: number - group_addresses: - type: array - items: - type: string - external_rp: + - title: static_rp + required: + - static_rp + properties: + static_rp: + type: object + properties: + interface: + type: string + address: + type: string + override: + type: boolean + group_addresses: + type: array + items: + type: string + - title: candidate_rp + required: + - candidate_rp + properties: + candidate_rp: + type: object + properties: + interface: + type: string + address: + type: string + priority: + type: number + advertisement_interval: + type: number + group_addresses: + type: array + items: + type: string + external_rp: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - group_addresses: + group_addresses: type: array - items: - type: string - override: + items: + type: string + override: type: boolean - rip: + rip: type: object - properties: - enable: + properties: + enable: type: boolean - default_information_originate: + default_information_originate: type: boolean - global_timer: + global_timer: type: string - auth_profile: + auth_profile: type: string - redistribution_profile: + redistribution_profile: type: string - global_bfd: + global_bfd: type: object - properties: - profile: + properties: + profile: type: string - global_inbound_distribute_list: + global_inbound_distribute_list: type: object - properties: - access_list: + properties: + access_list: type: string - global_outbound_distribute_list: + global_outbound_distribute_list: type: object - properties: - access_list: + properties: + access_list: type: string - interface: + interface: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - enable: + enable: type: boolean - mode: + mode: type: string enum: - active - passive - send-only - split_horizon: + split_horizon: type: string enum: - split-horizon - no-split-horizon - no-split-horizon-with-poison-reverse - authentication: + authentication: type: string - bfd: + bfd: type: object - properties: - profile: + properties: + profile: type: string - interface_inbound_distribute_list: + interface_inbound_distribute_list: type: object - properties: - access_list: + properties: + access_list: type: string - metric: + metric: type: number - interface_outbound_distribute_list: + interface_outbound_distribute_list: type: object - properties: - access_list: + properties: + access_list: type: string - metric: + metric: type: number - bgp: + bgp: type: object - properties: - enable: + properties: + enable: type: boolean - router_id: + router_id: type: string - local_as: + local_as: type: string confederation_member_as: type: string - install_route: + install_route: type: boolean - enforce_first_as: + enforce_first_as: type: boolean - fast_external_failover: + fast_external_failover: type: boolean - ecmp_multi_as: + ecmp_multi_as: type: boolean - default_local_preference: + default_local_preference: type: number - graceful_shutdown: + graceful_shutdown: type: boolean - always_advertise_network_route: + always_advertise_network_route: type: boolean - reject_default_route: + reject_default_route: type: boolean - allow_redist_default_route: + allow_redist_default_route: type: boolean - as_format: + as_format: type: string - med: + med: type: object - properties: - always_compare_med: + properties: + always_compare_med: type: boolean - deterministic_med_comparison: + deterministic_med_comparison: type: boolean - aggregate: + aggregate: type: object - properties: - aggregate_med: + properties: + aggregate_med: type: boolean - graceful_restart: + graceful_restart: type: object - properties: - enable: + properties: + enable: type: boolean - stale_route_time: + stale_route_time: type: number - max_peer_restart_time: + max_peer_restart_time: type: number - local_restart_time: + local_restart_time: type: number - global_bfd: + global_bfd: type: object - properties: - profile: + properties: + profile: type: string - peer_group: + peer_group: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - enable: + enable: type: boolean - aggregated_confed_as_path: + aggregated_confed_as_path: type: boolean - soft_reset_with_stored_info: + soft_reset_with_stored_info: type: boolean - type: + type: type: object oneOf: - - title: ibgp - required: - - ibgp - properties: - ibgp: - type: object - properties: - export_nexthop: - type: string - - title: ebgp_confed - required: - - ebgp_confed - properties: - ebgp_confed: - type: object - properties: - export_nexthop: - type: string - - title: ibgp_confed - required: - - ibgp_confed - properties: - ibgp_confed: - type: object - properties: - export_nexthop: - type: string - - title: ebgp - required: - - ebgp - properties: - ebgp: - type: object - properties: - import_nexthop: - type: string - export_nexthop: - type: string - remove_private_as: - type: boolean - address_family: + - title: ibgp + required: + - ibgp + properties: + ibgp: + type: object + properties: + export_nexthop: + type: string + - title: ebgp_confed + required: + - ebgp_confed + properties: + ebgp_confed: + type: object + properties: + export_nexthop: + type: string + - title: ibgp_confed + required: + - ibgp_confed + properties: + ibgp_confed: + type: object + properties: + export_nexthop: + type: string + - title: ebgp + required: + - ebgp + properties: + ebgp: + type: object + properties: + import_nexthop: + type: string + export_nexthop: + type: string + remove_private_as: + type: boolean + address_family: type: object - properties: - ipv4: + properties: + ipv4: type: string - ipv6: + ipv6: type: string - filtering_profile: + filtering_profile: type: object - properties: - ipv4: + properties: + ipv4: type: string - ipv6: + ipv6: type: string - connection_options: + connection_options: type: object - properties: - timers: + properties: + timers: type: string - multihop: + multihop: type: number - authentication: + authentication: type: string - dampening: + dampening: type: string - peer: + peer: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - enable: + enable: type: boolean - passive: + passive: type: boolean - peer_as: + peer_as: type: string - peering_type: + peering_type: type: string - reflector_client: + reflector_client: type: string - subsequent_address_family_identifier: + subsequent_address_family_identifier: type: object - properties: - unicast: + properties: + unicast: type: boolean - multicast: + multicast: type: boolean - enable_sender_side_loop_detection: + enable_sender_side_loop_detection: type: boolean - enable_mp_bgp: + enable_mp_bgp: type: boolean - inherit: + inherit: type: object oneOf: - - title: ipv4 - required: - - ipv4 - properties: - yes: - type: object - properties: {} - - title: 'no' - required: - - 'no' - properties: - no: - type: object - properties: - address_family: - type: object - properties: - ipv4: - type: string - ipv6: - type: string - filtering_profile: - type: object - properties: - ipv4: - type: string - ipv6: - type: string - local_address: + - title: ipv4 + required: + - ipv4 + properties: + yes: + type: object + properties: {} + - title: 'no' + required: + - 'no' + properties: + no: + type: object + properties: + address_family: + type: object + properties: + ipv4: + type: string + ipv6: + type: string + filtering_profile: + type: object + properties: + ipv4: + type: string + ipv6: + type: string + local_address: type: object - properties: - interface: + properties: + interface: type: string - ip: + ip: type: string - peer_address: + peer_address: type: object oneOf: - - title: ip - required: - - ip - properties: - ip: - type: string - - title: fqdn - required: - - fqdn - properties: - fqdn: - type: string - connection_options: + - title: ip + required: + - ip + properties: + ip: + type: string + - title: fqdn + required: + - fqdn + properties: + fqdn: + type: string + connection_options: type: object - properties: - keep_alive_interval: + properties: + keep_alive_interval: type: string - hold_time: + hold_time: type: string - idle_hold_time: + idle_hold_time: type: number - min_route_adv_interval: + min_route_adv_interval: type: number - multihop: + multihop: type: string - open_delay_time: + open_delay_time: type: number - incoming_bgp_connection: + incoming_bgp_connection: type: object - properties: - remote_port: + properties: + remote_port: type: number - allow: + allow: type: boolean - outgoing_bgp_connection: + outgoing_bgp_connection: type: object - properties: - local_port: + properties: + local_port: type: number - allow: + allow: type: boolean - max_prefixes: + max_prefixes: type: string - timers: + timers: type: string - authentication: + authentication: type: string - dampening: + dampening: type: string - bfd: + bfd: type: object - properties: - profile: + properties: + profile: type: string - multihop: + multihop: type: object - properties: - min_received_ttl: + properties: + min_received_ttl: type: number - aggregate_routes: + aggregate_routes: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - description: + description: type: string - enable: + enable: type: boolean - summary_only: + summary_only: type: boolean - as_set: + as_set: type: boolean - same_med: + same_med: type: boolean - type: + type: type: object oneOf: - - title: ipv4 - required: - - ipv4 - properties: - ipv4: - type: object - properties: - summary_prefix: - type: string - suppress_map: - type: string - attribute_map: - type: string - - title: ipv6 - required: - - ipv6 - properties: - ipv6: - type: object - properties: - summary_prefix: - type: string - suppress_map: - type: string - attribute_map: - type: string - redistribution_profile: + - title: ipv4 + required: + - ipv4 + properties: + ipv4: + type: object + properties: + summary_prefix: + type: string + suppress_map: + type: string + attribute_map: + type: string + - title: ipv6 + required: + - ipv6 + properties: + ipv6: + type: object + properties: + summary_prefix: + type: string + suppress_map: + type: string + attribute_map: + type: string + redistribution_profile: type: object - properties: - ipv4: + properties: + ipv4: type: object - properties: - unicast: + properties: + unicast: type: string - ipv6: + ipv6: type: object - properties: - unicast: + properties: + unicast: type: string - advertise_network: + advertise_network: type: object - properties: - ipv4: + properties: + ipv4: type: object - properties: - network: + properties: + network: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - unicast: + unicast: type: boolean - multicast: + multicast: type: boolean - backdoor: + backdoor: type: boolean - ipv6: + ipv6: type: object - properties: - network: + properties: + network: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - unicast: + unicast: type: boolean - policy: + policy: type: object - properties: - import: + properties: + import: type: object - properties: - rules: + properties: + rules: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - enable: + enable: type: boolean - used_by: + used_by: type: array - items: - type: string - match: + items: + type: string + match: type: object - properties: - afi: + properties: + afi: type: string enum: - ip - ipv6 - safi: + safi: type: string enum: - ip - ipv6 - route_table: + route_table: type: string enum: - unicast - multicast - both - address_prefix: + address_prefix: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - exact: + exact: type: boolean - nexthop: + nexthop: type: array - items: - type: string - from_peer: + items: + type: string + from_peer: type: array - items: - type: string - med: + items: + type: string + med: type: number - as_path: + as_path: type: object - properties: - regex: + properties: + regex: type: string - community: + community: type: object - properties: - regex: + properties: + regex: type: string - extended_community: + extended_community: type: object - properties: - regex: - type: string - action: - type: object - oneOf: - - title: deny - required: - - deny - properties: - deny: - type: object - properties: {} - - title: allow - required: - - allow - properties: - allow: - type: object - properties: - dampening: - type: string - update: - type: object - properties: - local_preference: - type: number - med: - type: number - weight: - type: number - nexthop: - type: string - origin: - type: string - enum: - - igp - - egp - - incomplete - as_path_limit: - type: number - as_path: - type: object - oneOf: - - title: none - required: - - none - properties: - none: - type: object - properties: {} - - title: remove - required: - - remove - properties: - remove: - type: object - properties: {} - - title: prepend - required: - - prepend - properties: - prepend: - type: number - - title: remove_and_prepend - required: - - remove_and_prepend - properties: - remove_and_prepend: - type: number - community: - type: object - oneOf: - - title: none - required: - - none - properties: - none: - type: object - properties: {} - - title: remove_all - required: - - remove_all - properties: - remove_all: - type: object - properties: {} - - title: remove_regex - required: - - remove_regex - properties: - remove_regex: - type: string - - title: append - required: - - append - properties: - append: - type: array - items: - type: string - - title: overwrite - required: - - overwrite - properties: - overwrite: - type: array - items: - type: string - extended_community: - type: object - oneOf: - - title: none - required: - - none - properties: - none: - type: object - properties: {} - - title: remove_all - required: - - remove_all - properties: - remove_all: - type: object - properties: {} - - title: remove_regex - required: - - remove_regex - properties: - remove_regex: - type: string - - title: append - required: - - append - properties: - append: - type: array - items: - type: string - - title: overwrite - required: - - overwrite - properties: - overwrite: - type: array - items: - type: string - export: + properties: + regex: + type: string + action: + type: object + oneOf: + - title: deny + required: + - deny + properties: + deny: + type: object + properties: {} + - title: allow + required: + - allow + properties: + allow: + type: object + properties: + dampening: + type: string + update: + type: object + properties: + local_preference: + type: number + med: + type: number + weight: + type: number + nexthop: + type: string + origin: + type: string + enum: + - igp + - egp + - incomplete + as_path_limit: + type: number + as_path: + type: object + oneOf: + - title: none + required: + - none + properties: + none: + type: object + properties: {} + - title: remove + required: + - remove + properties: + remove: + type: object + properties: {} + - title: prepend + required: + - prepend + properties: + prepend: + type: number + - title: remove_and_prepend + required: + - remove_and_prepend + properties: + remove_and_prepend: + type: number + community: + type: object + oneOf: + - title: none + required: + - none + properties: + none: + type: object + properties: {} + - title: remove_all + required: + - remove_all + properties: + remove_all: + type: object + properties: {} + - title: remove_regex + required: + - remove_regex + properties: + remove_regex: + type: string + - title: append + required: + - append + properties: + append: + type: array + items: + type: string + - title: overwrite + required: + - overwrite + properties: + overwrite: + type: array + items: + type: string + extended_community: + type: object + oneOf: + - title: none + required: + - none + properties: + none: + type: object + properties: {} + - title: remove_all + required: + - remove_all + properties: + remove_all: + type: object + properties: {} + - title: remove_regex + required: + - remove_regex + properties: + remove_regex: + type: string + - title: append + required: + - append + properties: + append: + type: array + items: + type: string + - title: overwrite + required: + - overwrite + properties: + overwrite: + type: array + items: + type: string + export: type: object - properties: - rules: + properties: + rules: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - enable: + enable: type: boolean - used_by: + used_by: type: array - items: + items: type: string - match: + match: type: object - properties: - afi: + properties: + afi: type: string enum: - ip - ipv6 - safi: + safi: type: string enum: - ip - ipv6 - route_table: + route_table: type: string enum: - unicast - multicast - both - address_prefix: + address_prefix: type: array - items: + items: type: object - properties: - name: + properties: + name: type: string - exact: + exact: type: boolean - nexthop: + nexthop: type: array - items: + items: type: string - from_peer: + from_peer: type: array - items: + items: type: string - med: + med: type: number - as_path: + as_path: type: object - properties: - regex: + properties: + regex: type: string - community: + community: type: object - properties: - regex: + properties: + regex: type: string - extended_community: + extended_community: type: object - properties: - regex: + properties: + regex: type: string - action: + action: type: object oneOf: - - title: deny - required: - - deny - properties: - deny: - type: object - properties: {} - - title: allow - required: - - allow - properties: - allow: - type: object - properties: - update: - type: object - properties: - local_preference: - type: number - med: - type: number - nexthop: - type: string - origin: - type: string - enum: - - igp - - egp - - multicast - as_path_limit: - type: number - as_path: - type: object - oneOf: - - title: none - required: - - none - properties: - none: - type: object - properties: {} - - title: remove - required: - - remove - properties: - remove: - type: object - properties: {} - - title: prepend - required: - - prepend - properties: - prepend: - type: number - - title: remove_and_prepend - required: - - remove_and_prepend - properties: - remove_and_prepend: - type: number - community: - type: object - oneOf: - - title: none - required: - - none - properties: - none: - type: object - properties: {} - - title: remove_all - required: - - remove_all - properties: - remove_all: - type: object - properties: {} - - title: remove_regex - required: - - remove_regex - properties: - remove_regex: - type: string - - title: append - required: - - append - properties: - append: - type: array - items: - type: string - - title: overwrite - required: - - overwrite - properties: - overwrite: - type: array - items: - type: string - extended_community: - type: object - oneOf: - - title: none - required: - - none - properties: - none: - type: object - properties: {} - - title: remove_all - required: - - remove_all - properties: - remove_all: - type: object - properties: {} - - title: remove_regex - required: - - remove_regex - properties: - remove_regex: - type: string - - title: append - required: - - append - properties: - append: - type: array - items: - type: string - - title: overwrite - required: - - overwrite - properties: - overwrite: - type: array - items: - type: string - conditional_advertisement: + - title: deny + required: + - deny + properties: + deny: + type: object + properties: {} + - title: allow + required: + - allow + properties: + allow: + type: object + properties: + update: + type: object + properties: + local_preference: + type: number + med: + type: number + nexthop: + type: string + origin: + type: string + enum: + - igp + - egp + - multicast + as_path_limit: + type: number + as_path: + type: object + oneOf: + - title: none + required: + - none + properties: + none: + type: object + properties: {} + - title: remove + required: + - remove + properties: + remove: + type: object + properties: {} + - title: prepend + required: + - prepend + properties: + prepend: + type: number + - title: remove_and_prepend + required: + - remove_and_prepend + properties: + remove_and_prepend: + type: number + community: + type: object + oneOf: + - title: none + required: + - none + properties: + none: + type: object + properties: {} + - title: remove_all + required: + - remove_all + properties: + remove_all: + type: object + properties: {} + - title: remove_regex + required: + - remove_regex + properties: + remove_regex: + type: string + - title: append + required: + - append + properties: + append: + type: array + items: + type: string + - title: overwrite + required: + - overwrite + properties: + overwrite: + type: array + items: + type: string + extended_community: + type: object + oneOf: + - title: none + required: + - none + properties: + none: + type: object + properties: {} + - title: remove_all + required: + - remove_all + properties: + remove_all: + type: object + properties: {} + - title: remove_regex + required: + - remove_regex + properties: + remove_regex: + type: string + - title: append + required: + - append + properties: + append: + type: array + items: + type: string + - title: overwrite + required: + - overwrite + properties: + overwrite: + type: array + items: + type: string + conditional_advertisement: type: object - properties: - policy: + properties: + policy: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - enable: + enable: type: boolean - used_by: + used_by: type: array - items: + items: type: object - properties: {} - non_exist_filters: + properties: {} + non_exist_filters: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - enable: + enable: type: boolean - match: + match: type: object - properties: - afi: + properties: + afi: type: string enum: - ip - ipv6 - safi: + safi: type: string enum: - ip - ipv6 - route_table: + route_table: type: string enum: - unicast - multicast - both - address_prefix: + address_prefix: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - exact: + exact: type: boolean - nexthop: + nexthop: type: array - items: + items: type: string - from_peer: + from_peer: type: array - items: + items: type: string - med: + med: type: number - as_path: + as_path: type: object - properties: - regex: + properties: + regex: type: string - community: + community: type: object - properties: - regex: + properties: + regex: type: string - extended_community: + extended_community: type: object - properties: - regex: + properties: + regex: type: string - advertise_filters: + advertise_filters: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - enable: + enable: type: boolean - match: + match: type: object - properties: - afi: + properties: + afi: type: string enum: - ip - ipv6 - safi: + safi: type: string enum: - ip - ipv6 - route_table: + route_table: type: string enum: - unicast - multicast - both - address_prefix: + address_prefix: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - exact: + exact: type: boolean - nexthop: + nexthop: type: array - items: + items: type: string - from_peer: + from_peer: type: array - items: + items: type: string - med: + med: type: number - as_path: + as_path: type: object - properties: - regex: + properties: + regex: type: string - community: + community: type: object - properties: - regex: + properties: + regex: type: string - extended_community: + extended_community: type: object - properties: - regex: + properties: + regex: type: string - aggregation: + aggregation: type: object - properties: - address: + properties: + address: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - prefix: + prefix: type: string - enable: + enable: type: boolean - summary: + summary: type: boolean - as_set: + as_set: type: boolean - aggregate_route_attributes: + aggregate_route_attributes: type: object - properties: - local_preference: + properties: + local_preference: type: number - med: + med: type: number - weight: + weight: type: number - nexthop: + nexthop: type: string - origin: + origin: type: string enum: - igp - egp - incomplete - as_path_limit: + as_path_limit: type: number - as_path: + as_path: type: object oneOf: - - title: none - required: - - none - properties: - none: - type: object - properties: {} - - title: remove - required: - - remove - properties: - remove: - type: object - properties: {} - - title: prepend - required: - - prepend - properties: - prepend: - type: number - - title: remove_and_prepend - required: - - remove_and_prepend - properties: - remove_and_prepend: - type: number - community: + - title: none + required: + - none + properties: + none: + type: object + properties: {} + - title: remove + required: + - remove + properties: + remove: + type: object + properties: {} + - title: prepend + required: + - prepend + properties: + prepend: + type: number + - title: remove_and_prepend + required: + - remove_and_prepend + properties: + remove_and_prepend: + type: number + community: type: object oneOf: - - title: none - required: - - none - properties: - none: - type: object - properties: {} - - title: remove_all - required: - - remove_all - properties: - remove_all: - type: object - properties: {} - - title: remove_regex - required: - - remove_regex - properties: - remove_regex: - type: string - - title: append - required: - - append - properties: - append: - type: array - items: - type: string - - title: overwrite - required: - - overwrite - properties: - overwrite: - type: array - items: + - title: none + required: + - none + properties: + none: + type: object + properties: {} + - title: remove_all + required: + - remove_all + properties: + remove_all: + type: object + properties: {} + - title: remove_regex + required: + - remove_regex + properties: + remove_regex: type: string - extended_community: + - title: append + required: + - append + properties: + append: + type: array + items: + type: string + - title: overwrite + required: + - overwrite + properties: + overwrite: + type: array + items: + type: string + extended_community: type: object oneOf: - - title: none - required: - - none - properties: - none: - type: object - properties: {} - - title: remove_all - required: - - remove_all - properties: - remove_all: - type: object - properties: {} - - title: remove_regex - required: - - remove_regex - properties: - remove_regex: - type: string - - title: append - required: - - append - properties: - append: - type: array - items: + - title: none + required: + - none + properties: + none: + type: object + properties: {} + - title: remove_all + required: + - remove_all + properties: + remove_all: + type: object + properties: {} + - title: remove_regex + required: + - remove_regex + properties: + remove_regex: type: string - - title: overwrite - required: - - overwrite - properties: - overwrite: - type: array - items: - type: string - suppress_filters: + - title: append + required: + - append + properties: + append: + type: array + items: + type: string + - title: overwrite + required: + - overwrite + properties: + overwrite: + type: array + items: + type: string + suppress_filters: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - enable: + enable: type: boolean - match: + match: type: object - properties: - afi: + properties: + afi: type: string enum: - ip - ipv6 - safi: + safi: type: string enum: - ip - ipv6 - route_table: + route_table: type: string enum: - unicast - multicast - both - address_prefix: + address_prefix: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - exact: + exact: type: boolean - nexthop: + nexthop: type: array - items: + items: type: string - from_peer: + from_peer: type: array - items: - type: string - med: + items: + type: string + med: type: number - as_path: + as_path: type: object - properties: - regex: + properties: + regex: type: string - community: + community: type: object - properties: - regex: + properties: + regex: type: string - extended_community: + extended_community: type: object - properties: - regex: + properties: + regex: type: string - advertise_filters: + advertise_filters: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - enable: + enable: type: boolean - match: + match: type: object - properties: - afi: + properties: + afi: type: string enum: - ip - ipv6 - safi: + safi: type: string enum: - ip - ipv6 - route_table: + route_table: type: string enum: - unicast - multicast - both - address_prefix: + address_prefix: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - exact: + exact: type: boolean - nexthop: + nexthop: type: array - items: + items: type: string - from_peer: + from_peer: type: array - items: - type: string - med: + items: + type: string + med: type: number - as_path: + as_path: type: object - properties: - regex: + properties: + regex: type: string - community: + community: type: object - properties: - regex: + properties: + regex: type: string - extended_community: + extended_community: type: object - properties: - regex: + properties: + regex: type: string - redist_rules: + redist_rules: type: array - items: + items: type: object required: - 'name' - properties: - name: + properties: + name: type: string - address_family_identifier: + address_family_identifier: type: string enum: - ipv4 - ipv6 - route_table: + route_table: type: string enum: - unicast - multicast - both - enable: + enable: type: boolean - set_origin: + set_origin: type: string enum: - igp - egp - incomplete - set_med: + set_med: type: number - set_local_preference: + set_local_preference: type: number - set_as_path_limit: + set_as_path_limit: type: number - set_community: + set_community: type: array - items: - type: string - set_extended_community: + items: + type: string + set_extended_community: type: array - items: + items: type: string - metric: + metric: type: number oneOf: - type: object @@ -14891,7 +15043,7 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder @@ -14902,7 +15054,7 @@ components: properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet @@ -14913,7 +15065,7 @@ components: properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device @@ -14934,74 +15086,73 @@ components: type: string anyOf: - oneOf: - - title: password - type: object - required: - - password - properties: - password: - description: Password - type: string - format: password - - title: md5 - type: object - required: - - md5 - properties: - md5: - description: MD5s - type: array - items: - type: object - properties: - name: - description: Key ID - type: integer - minimum: 1 - maximum: 255 - key: - description: MD5 hash - type: string - maxLength: 16 - format: password - preferred: - description: Preferred? - type: boolean + - title: password + type: object + required: + - password + properties: + password: + description: Password + type: string + format: password + - title: md5 + type: object + required: + - md5 + properties: + md5: + description: MD5s + type: array + items: + type: object + properties: + name: + description: Key ID + type: integer + minimum: 1 + maximum: 255 + key: + description: MD5 hash + type: string + maxLength: 16 + format: password + preferred: + description: Preferred? + type: boolean - oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device pbf-rules: type: object properties: @@ -15027,24 +15178,24 @@ components: from: type: object oneOf: - - title: zone - type: object - properties: - zone: - description: Source zones - type: array - items: - description: Source zone name - type: string - - title: interface - type: object - properties: - interface: - description: Source interfaces - type: array - items: - description: Source interface name - type: string + - title: zone + type: object + properties: + zone: + description: Source zones + type: array + items: + description: Source zone name + type: string + - title: interface + type: object + properties: + interface: + description: Source interfaces + type: array + items: + description: Source interface name + type: string source: description: Source addresses type: array @@ -15076,52 +15227,52 @@ components: action: type: object oneOf: - - title: forward - type: object - properties: - forward: - type: object - properties: - egress_interface: - description: Egress interface - type: string - nexthop: - type: object - oneOf: - - title: ip-address + - title: forward + type: object + properties: + forward: + type: object + properties: + egress_interface: + description: Egress interface + type: string + nexthop: + type: object + oneOf: + - title: ip-address + properties: + ip_address: + description: Next hop IP address + type: string + - title: fqdn + properties: + fqdn: + description: Next hop FQDN + type: string + monitor: + type: object properties: - ip-address: - description: Next hop IP address + profile: + description: Monitoring profile type: string - - title: fqdn - properties: - fqdn: - description: Next hop FQDN + disable_if_unreachable: + description: Disable this rule if nexthop/monitor ip is unreachable? + type: boolean + ip_address: + description: Monitor IP address type: string - monitor: - type: object - properties: - profile: - description: Monitoring profile - type: string - disable_if_unreachable: - description: Disable this rule if nexthop/monitor ip is unreachable? - type: boolean - ip-address: - description: Monitor IP address - type: string - - title: discard - type: object - properties: - discard: - type: object - default: {} - - title: no_pbf - type: object - properties: - no_pbf: - type: object - default: {} + - title: discard + type: object + properties: + discard: + type: object + default: {} + - title: no_pbf + type: object + properties: + no_pbf: + type: object + default: {} enforce_symmetric_return: type: object properties: @@ -15133,45 +15284,44 @@ components: type: array items: type: object - properties: + properties: name: description: Next hop IP address type: string oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device route-access-lists: type: object required: @@ -15252,40 +15402,39 @@ components: description: Destination IP wildcard type: string oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device route-community-lists: type: object required: @@ -15407,40 +15556,39 @@ components: type: string maxItems: 8 oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device route-path-access-lists: type: object required: @@ -15478,40 +15626,39 @@ components: description: AS path regular expression type: string oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device route-prefix-lists: type: object required: @@ -15581,40 +15728,39 @@ components: minimum: 0 maximum: 32 oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device auto-vpn-clusters: type: object properties: @@ -15639,8 +15785,8 @@ components: description: VPN cluster type type: string enum: - - hub-spoke - - mesh + - hub-spoke + - mesh default: hub-spoke branches: description: Branches @@ -15688,16 +15834,16 @@ components: static_ip: type: object oneOf: - - title: ip_address - properties: - ip_address: - description: IP address - type: string - - title: fqdn - properties: - fqdn: - description: FQDN - type: string + - title: ip_address + properties: + ip_address: + description: IP address + type: string + - title: fqdn + properties: + fqdn: + description: FQDN + type: string sdwan_gateway: description: Next hop gateway type: string @@ -15727,16 +15873,16 @@ components: static_ip: type: object oneOf: - - title: ip_address - properties: - ip_address: - description: IP address - type: string - - title: fqdn - properties: - fqdn: - description: FQDN - type: string + - title: ip_address + properties: + ip_address: + description: IP address + type: string + - title: fqdn + properties: + fqdn: + description: FQDN + type: string sdwan_gateway: description: Next hop gateway type: string @@ -15800,16 +15946,16 @@ components: static_ip: type: object oneOf: - - title: ip_address - properties: - ip_address: - description: IP address - type: string - - title: fqdn - properties: - fqdn: - description: FQDN - type: string + - title: ip_address + properties: + ip_address: + description: IP address + type: string + - title: fqdn + properties: + fqdn: + description: FQDN + type: string sdwan_gateway: description: Next hop gateway type: string @@ -15837,20 +15983,19 @@ components: static_ip: type: object oneOf: - - title: ip_address - properties: - ip_address: - description: IP address - type: string - - title: fqdn - properties: - fqdn: - description: FQDN - type: string + - title: ip_address + properties: + ip_address: + description: IP address + type: string + - title: fqdn + properties: + fqdn: + description: FQDN + type: string sdwan_gateway: description: Next hop gateway type: string - auto-vpn-monitor: type: object properties: @@ -15902,7 +16047,6 @@ components: ts: description: Timestamp type: string - # auto-vpn-objects: # type: object # properties: @@ -17149,7 +17293,6 @@ components: # metric: # type: number # example: 1 - auto-vpn-push-config: type: object properties: @@ -17165,7 +17308,6 @@ components: refresh_psk: type: boolean default: true - auto-vpn-push-response: type: object properties: @@ -17178,11 +17320,10 @@ components: message: description: Job message type: string - auto-vpn-settings: required: - - vpn_address_pool - - as_range + - vpn_address_pool + - as_range type: object properties: vpn_address_pool: @@ -17204,7 +17345,6 @@ components: enable_mesh_between_hubs: description: Enable mesh connection between hubs? type: boolean - sdwan-error-correction-profiles: type: object required: @@ -17225,27 +17365,27 @@ components: mode: type: object oneOf: - - title: forward_error_correction - type: object - required: - - forward_error_correction - properties: - forward_error_correction: - type: object - required: - - ratio - - recovery_duration - properties: - ratio: - type: string - recovery_duration: - type: number - - title: packet_duplication - type: object - required: - - packet_duplication - properties: - packet_duplication: + - title: forward_error_correction + type: object + required: + - forward_error_correction + properties: + forward_error_correction: + type: object + required: + - ratio + - recovery_duration + properties: + ratio: + type: string + recovery_duration: + type: number + - title: packet_duplication + type: object + required: + - packet_duplication + properties: + packet_duplication: type: object required: - recovery_duration_pd @@ -17253,40 +17393,39 @@ components: recovery_duration_pd: type: number oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device sdwan-path-quality-profiles: type: object required: @@ -17329,7 +17468,7 @@ components: - low - medium - high - pkt-loss: + pkt_loss: type: object required: - threshold @@ -17370,54 +17509,53 @@ components: - medium - high oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device sdwan-rules: type: object required: - - name - - from - - position - - to - - source - - source_user - - destination - - application - - service - - action - - path_quality_profile + - name + - from + - position + - to + - source + - source_user + - destination + - application + - service + - action + - path_quality_profile properties: id: type: string @@ -17434,8 +17572,8 @@ components: description: Rule postion relative to device rules type: string enum: - - pre - - post + - pre + - post disabled: description: Disable rule? type: boolean @@ -17507,51 +17645,50 @@ components: action: type: object required: - - traffic_distribution_profile + - traffic_distribution_profile properties: traffic_distribution_profile: description: Traffic dstribution profile type: string oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device sdwan-saas-quality-profiles: type: object required: - - name - - monitor_mode + - name + - monitor_mode properties: id: type: string @@ -17564,72 +17701,72 @@ components: monitor_mode: type: object oneOf: - - title: adaptive - type: object - required: - - adaptive - properties: - adaptive: - type: object - default: {} - - title: static_ip - type: object - required: - - static_ip - properties: - static_ip: - type: object - oneOf: - - title: ip_address - required: - - ip_address - properties: - ip_address: - description: List of IP addresses - type: array - items: - type: object - required: - - name - - probe_interval - properties: - name: - description: IP address + - title: adaptive + type: object + required: + - adaptive + properties: + adaptive: + type: object + default: {} + - title: static_ip + type: object + required: + - static_ip + properties: + static_ip: + type: object + oneOf: + - title: ip_address + required: + - ip_address + properties: + ip_address: + description: List of IP addresses + type: array + items: + type: object + required: + - name + - probe_interval + properties: + name: + description: IP address + type: string + format: ip-address + probe_interval: + description: Probe interval (seconds) + type: integer + minimum: 1 + maximum: 60 + - title: fqdn + required: + - fqdn + properties: + fqdn: + type: object + required: + - fqdn_name + - probe_interval + properties: + fqdn_name: + description: FQDN type: string - format: ip-address probe_interval: description: Probe interval (seconds) type: integer minimum: 1 maximum: 60 - - title: fqdn - required: - - fqdn - properties: - fqdn: - type: object - required: - - fqdn_name - - probe_interval - properties: - fqdn_name: - description: FQDN - type: string - probe_interval: - description: Probe interval (seconds) - type: integer - minimum: 1 - maximum: 60 - - title: http_https - type: object - required: - - http_https - properties: - http_https: + - title: http_https + type: object + required: + - http_https + properties: + http_https: type: object required: - - monitored_url - - probe_interval + - monitored_url + - probe_interval properties: monitored_url: description: Monitored URL @@ -17641,40 +17778,39 @@ components: minimum: 1 maximum: 60 oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device sdwan-traffic-distribution-profiles: type: object required: @@ -17691,7 +17827,7 @@ components: description: Profile name type: string maxLength: 31 - traffic-distribution: + traffic_distribution: description: Traffic distribution type: string enum: @@ -17699,7 +17835,7 @@ components: - Top Down Priority - Weighted Session Distribution default: Best Available Path - link-tags: + link_tags: type: array description: Link-Tags for interfaces identified by defined tags items: @@ -17715,42 +17851,41 @@ components: description: Weight (percentage) (only used when `traffic-distribution` is `Weighted Session Distribution`) type: integer minimum: 0 - maximum: 100 - oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + maximum: 100 + oneOf: + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device dhcp-interfaces: type: object required: @@ -17765,250 +17900,249 @@ components: description: Interface name type: string anyOf: - - oneOf: - - title: server - required: - - server - properties: - server: - type: object + - oneOf: + - title: server + required: + - server properties: - probe_ip: - description: Ping IP before allocating? - type: boolean - mode: - description: DHCP server mode - type: string - enum: - - auto - - enabled - - disabled - option: + server: type: object properties: - lease: - type: object - oneOf: - - title: unlimited - properties: - unlimited: - type: object - default: {} - - title: timeout - properties: - timeout: - description: DHCP lease timeout (minutes) - type: integer - minimum: 0 - maximum: 1000000 - inheritance: - type: object - properties: - source: - description: Interface from which to inherit lease options - type: string - gateway: - description: Default gateway - type: string - subnet_mask: - description: Subnet mask + probe_ip: + description: Ping IP before allocating? + type: boolean + mode: + description: DHCP server mode type: string - dns: - type: object - properties: - primary: - description: Primary DNS server - type: string - format: ip-address - example: inherited - secondary: - description: Secondary DNS server - type: string - format: ip-address - example: inherited - wins: + enum: + - auto + - enabled + - disabled + option: type: object properties: - primary: - description: Primary WINS server - type: string - format: ip-address - example: inherited - secondary: - description: Secondary WINS server + lease: + type: object + oneOf: + - title: unlimited + properties: + unlimited: + type: object + default: {} + - title: timeout + properties: + timeout: + description: DHCP lease timeout (minutes) + type: integer + minimum: 0 + maximum: 1000000 + inheritance: + type: object + properties: + source: + description: Interface from which to inherit lease options + type: string + gateway: + description: Default gateway type: string - format: ip-address - example: inherited - nis: - type: object - properties: - primary: - description: Primary NIS server + subnet_mask: + description: Subnet mask type: string - format: ip-address - example: inherited - secondary: - description: Secondary NIS server + dns: + type: object + properties: + primary: + description: Primary DNS server + type: string + format: ip-address + example: inherited + secondary: + description: Secondary DNS server + type: string + format: ip-address + example: inherited + wins: + type: object + properties: + primary: + description: Primary WINS server + type: string + format: ip-address + example: inherited + secondary: + description: Secondary WINS server + type: string + format: ip-address + example: inherited + nis: + type: object + properties: + primary: + description: Primary NIS server + type: string + format: ip-address + example: inherited + secondary: + description: Secondary NIS server + type: string + format: ip-address + example: inherited + ntp: + type: object + properties: + primary: + description: Primary NTP server + type: string + format: ip-address + example: inherited + secondary: + description: Secondary NTP server + type: string + format: ip-address + example: inherited + pop3_server: + description: POP3 server type: string - format: ip-address example: inherited - ntp: - type: object - properties: - primary: - description: Primary NTP server + smtp_server: + description: SMTP server type: string - format: ip-address example: inherited - secondary: - description: Secondary NTP server + dns_suffix: + description: DNS suffix type: string - format: ip-address example: inherited - pop3_server: - description: POP3 server - type: string - example: inherited - smtp_server: - description: SMTP server - type: string - example: inherited - dns_suffix: - description: DNS suffix - type: string - example: inherited - user_defined: - description: Custom DHCP options + user_defined: + description: Custom DHCP options + type: array + items: + type: object + required: + - name + - inherited + properties: + name: + description: Option name + type: string + code: + description: Option code + type: integer + minimum: 1 + maximum: 254 + inherited: + description: Inherited from DHCP server inheritance source? + type: boolean + oneOf: + - title: ip + required: + - ip + properties: + ip: + type: array + items: + description: List of IP addresses + type: string + - title: ascii + required: + - ascii + properties: + ascii: + type: array + items: + description: List of ASCII values + type: string + - title: hex + required: + - hex + properties: + hex: + type: array + items: + description: List of hexadecimal values + type: string + ip_pool: + description: List of IP address pools type: array items: - type: object - required: + description: IP address pool + type: string + reserved: + description: List of IP reservations + type: array + required: - name - - inherited + - mac + items: + type: object properties: name: - description: Option name + description: Reserved IP address type: string - code: - description: Option code - type: integer - minimum: 1 - maximum: 254 - inherited: - description: Inherited from DHCP server inheritance source? - type: boolean - oneOf: - - title: ip - required: - - ip - properties: - ip: - type: array - items: - description: List of IP addresses - type: string - - title: ascii - required: - - ascii - properties: - ascii: - type: array - items: - description: List of ASCII values - type: string - - title: hex - required: - - hex - properties: - hex: - type: array - items: - description: List of hexadecimal values - type: string - ip_pool: - description: List of IP address pools - type: array - items: - description: IP address pool - type: string - reserved: - description: List of IP reservations - type: array - required: - - name - - mac - items: - type: object - properties: - name: - description: Reserved IP address - type: string - format: ip-address - mac: - description: Reserved MAC address - type: string - format: mac-address - description: - description: Reservation description - type: string - - title: relay - properties: - relay: - type: object - required: - - ip + format: ip-address + mac: + description: Reserved MAC address + type: string + format: mac-address + description: + description: Reservation description + type: string + - title: relay properties: - ip: + relay: type: object required: - - enabled - - server + - ip properties: - enabled: - description: Enabled? - type: boolean - default: true - server: - type: array - items: - description: List of DHCP server IP addresses - type: string - format: ip-address - - oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + ip: + type: object + required: + - enabled + - server + properties: + enabled: + description: Enabled? + type: boolean + default: true + server: + type: array + items: + description: List of DHCP server IP addresses + type: string + format: ip-address + - oneOf: + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device dns-proxies: type: object required: @@ -18052,7 +18186,7 @@ components: items: description: Interface name type: string - domain-servers: + domain_servers: type: array description: DNS proxy rules items: @@ -18068,7 +18202,7 @@ components: cacheable: description: Enable caching for this DNS proxy rule? type: boolean - domain-name: + domain_name: type: array description: Domain names(s) that will be matched items: @@ -18084,7 +18218,7 @@ components: description: Secondary DNS server IP address type: string format: ip-address - static-entries: + static_entries: type: array items: description: Static domain name mappings @@ -18109,7 +18243,7 @@ components: type: string format: ip-address maxLength: 63 - tcp-queries: + tcp_queries: type: object required: - enabled @@ -18118,13 +18252,13 @@ components: description: Turn on forwarding of TCP DNS queries? type: boolean default: false - max-pending-requests: + max_pending_requests: description: Upper limit on number of concurrent TCP DNS requests type: integer minimum: 64 maximum: 256 default: 64 - udp-queries: + udp_queries: type: object properties: retries: @@ -18150,11 +18284,11 @@ components: description: Turn on caching for this DNS object type: boolean default: true - cache-edns: + cache_edns: description: Cache EDNS UDP response type: boolean default: true - max-ttl: + max_ttl: type: object required: - enabled @@ -18163,46 +18297,45 @@ components: description: Enable max ttl for this DNS object default: false type: boolean - time-to-live: + time_to_live: description: Time in seconds after which entry is cleared type: integer minimum: 60 maximum: 86400 oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device generic_error: type: object properties: @@ -18232,4 +18365,4 @@ components: type: string security: - scmToken: [] -x-internal: false +x-internal: false \ No newline at end of file diff --git a/openapi-specs/scm/config/sase/objects/objects .yaml b/openapi-specs/scm/config/sase/objects/objects-latest.yaml similarity index 95% rename from openapi-specs/scm/config/sase/objects/objects .yaml rename to openapi-specs/scm/config/sase/objects/objects-latest.yaml index 897fa7263..478d5aba3 100644 --- a/openapi-specs/scm/config/sase/objects/objects .yaml +++ b/openapi-specs/scm/config/sase/objects/objects-latest.yaml @@ -2681,7 +2681,7 @@ paths: $ref: '#/components/responses/conflict_errors' default: $ref: '#/components/responses/default_errors' - + /syslog-server-profiles: get: tags: @@ -3102,7 +3102,7 @@ components: Tenant Service Group (TSG) ID. The resulting JWT access token should be attached to all API calls as a `Bearer` token in the `Authorization` header (ex. `Authorization: Bearer tokenstring`). - flows: + flows: clientCredentials: tokenUrl: https://auth.apps.paloaltonetworks.com/oauth2/access_token scopes: {} @@ -3442,80 +3442,80 @@ components: - title: address_type description: The address object type oneOf: - - type: object - title: ip_netmask - properties: - ip_netmask: - type: string - description: IP address with or without CIDR notation - example: 192.168.80.0/24 - required: - - ip_netmask - - type: object - title: ip_range - properties: - ip_range: - type: string - example: 10.0.0.1-10.0.0.4 - required: - - ip_range - - type: object - title: ip_wildcard - properties: - ip_wildcard: - type: string - description: IP wildcard mask - example: 10.20.1.0/0.0.248.255 - required: - - ip_wildcard - - type: object - title: fqdn - properties: - fqdn: - type: string - pattern: '^[a-zA-Z0-9_]([a-zA-Z0-9._-])+[a-zA-Z0-9]$' - minLength: 1 - maxLength: 255 - description: Fully qualified domain name - example: some.example.com - required: - - fqdn + - type: object + title: ip_netmask + properties: + ip_netmask: + type: string + description: IP address with or without CIDR notation + example: 192.168.80.0/24 + required: + - ip_netmask + - type: object + title: ip_range + properties: + ip_range: + type: string + example: 10.0.0.1-10.0.0.4 + required: + - ip_range + - type: object + title: ip_wildcard + properties: + ip_wildcard: + type: string + description: IP wildcard mask + example: 10.20.1.0/0.0.248.255 + required: + - ip_wildcard + - type: object + title: fqdn + properties: + fqdn: + type: string + pattern: '^[a-zA-Z0-9_]([a-zA-Z0-9._-])+[a-zA-Z0-9]$' + minLength: 1 + maxLength: 255 + description: Fully qualified domain name + example: some.example.com + required: + - fqdn - title: container_type description: The type of configuration container in which the address object is defined oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device address-groups: type: object required: @@ -3546,74 +3546,74 @@ components: - title: group_type description: The address group type oneOf: - - type: object - title: static - properties: - static: - type: array - items: - type: string - maxLength: 63 - x-panMemberOf: - - location: shared - schema: address-group - subPath: name - description: Member address objects and/or groups - description: Static address group - required: - - static - - type: object - title: dynamic - properties: - dynamic: - type: object - properties: - filter: + - type: object + title: static + properties: + static: + type: array + items: type: string - description: Tag based filter defining group membership - maxLength: 2047 - example: tag1 AND tag2 OR tag3 - required: - - filter - description: Dynamic adddress group - required: - - dynamic + maxLength: 63 + x-panMemberOf: + - location: shared + schema: address-group + subPath: name + description: Member address objects and/or groups + description: Static address group + required: + - static + - type: object + title: dynamic + properties: + dynamic: + type: object + properties: + filter: + type: string + description: Tag based filter defining group membership + maxLength: 2047 + example: tag1 AND tag2 OR tag3 + required: + - filter + description: Dynamic adddress group + required: + - dynamic - title: container_type description: The type of configuration container in which the address object is defined oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device applications: type: object required: @@ -3950,39 +3950,39 @@ components: required: - name oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet - - type: object - title: device - properties: - device: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device + - type: object + title: folder + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + example: My Folder + required: + - folder + - type: object + title: snippet + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + example: My Snippet + required: + - snippet + - type: object + title: device + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + example: My Device + required: + - device application-filters: type: object required: @@ -4108,34 +4108,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device application-groups: type: object required: @@ -4176,34 +4176,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device auto-tag-actions: type: object required: @@ -4274,34 +4274,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device dynamic-user-groups: type: object required: @@ -4316,7 +4316,7 @@ components: example: 123e4567-e89b-12d3-a456-426655440000 name: type: string - pattern: ^[ a-zA-Z\d.-_]+$ + pattern: ^[ a-zA-Z\d.\-_]+$ description: The name of the dynamic address group maxLength: 63 description: @@ -4340,34 +4340,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device external-dynamic-lists: type: object required: @@ -4380,7 +4380,7 @@ components: example: 123e4567-e89b-12d3-a456-426655440000 name: type: string - pattern: ^[ a-zA-Z\d.-_]+$ + pattern: ^[ a-zA-Z\d.\-_]+$ description: The name of the external dynamic list maxLength: 63 type: @@ -5063,34 +5063,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device hip-objects: type: object required: @@ -5104,7 +5104,7 @@ components: example: 123e4567-e89b-12d3-a456-426655440000 name: type: string - pattern: ^[ a-zA-Z\d.-_]+$ + pattern: ^[ a-zA-Z\d.\-_]+$ description: The name of the HIP object maxLength: 31 description: @@ -6333,34 +6333,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device hip-profiles: type: object required: @@ -6375,7 +6375,7 @@ components: example: 123e4567-e89b-12d3-a456-426655440000 name: type: string - pattern: ^[ a-zA-Z\d.-_]+$ + pattern: ^[ a-zA-Z\d.\-_]+$ description: The name of the HIP profile maxLength: 31 description: @@ -6390,34 +6390,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device http-server-profiles: type: object required: @@ -6449,8 +6449,8 @@ components: description: HTTP server protocol type: string enum: - - HTTP - - HTTPS + - HTTP + - HTTPS port: description: HTTP server port type: integer @@ -6458,10 +6458,10 @@ components: description: HTTP server TLS version type: string enum: - - '1.0' - - '1.1' - - '1.2' - - '1.3' + - '1.0' + - '1.1' + - '1.2' + - '1.3' certificate_profile: description: HTTP server certificate profile type: string @@ -6470,10 +6470,10 @@ components: description: HTTP operation to perform type: string enum: - - GET - - POST - - PUT - - DELETE + - GET + - POST + - PUT + - DELETE tag_registration: description: Register tags on match type: boolean @@ -6520,34 +6520,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device log-forwarding-profiles: type: object required: @@ -6585,14 +6585,14 @@ components: description: Log type type: string enum: - - traffic - - threat - - wildfire - - url - - data - - tunnel - - auth - - decryption + - traffic + - threat + - wildfire + - url + - data + - tunnel + - auth + - decryption filter: description: Filter match criteria type: string @@ -6613,34 +6613,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device payload-format: type: object properties: @@ -6674,7 +6674,7 @@ components: description: Parameter value type: string payload: - description: | + description: | The log payload format. The accepted log field values are as follows. * `receive_time` * `serial` @@ -6763,34 +6763,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device schedules: type: object required: @@ -6907,34 +6907,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device services: type: object required: @@ -6947,7 +6947,7 @@ components: example: 123e4567-e89b-12d3-a456-426655440000 name: type: string - pattern: ^[ a-zA-Z\d.-_]+$ + pattern: ^[ a-zA-Z\d.\-_]+$ description: The name of the service maxLength: 63 description: @@ -7031,34 +7031,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device service-groups: type: object required: @@ -7073,7 +7073,7 @@ components: example: 123e4567-e89b-12d3-a456-426655440000 name: type: string - pattern: ^[ a-zA-Z\d.-_]+$ + pattern: ^[ a-zA-Z\d.\-_]+$ description: The name of the service group maxLength: 63 members: @@ -7102,35 +7102,35 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device - + required: + - device + syslog-server-profiles: type: object required: @@ -7207,8 +7207,8 @@ components: description: Transport protocol type: string enum: - - UDP - - TCP + - UDP + - TCP port: description: Syslog server port type: integer @@ -7218,55 +7218,55 @@ components: description: Syslog format type: string enum: - - BSD - - IETF + - BSD + - IETF facility: description: Syslog facility type: string enum: - - LOG_USER - - LOG_LOCAL0 - - LOG_LOCAL1 - - LOG_LOCAL2 - - LOG_LOCAL3 - - LOG_LOCAL4 - - LOG_LOCAL5 - - LOG_LOCAL6 - - LOG_LOCAL7 + - LOG_USER + - LOG_LOCAL0 + - LOG_LOCAL1 + - LOG_LOCAL2 + - LOG_LOCAL3 + - LOG_LOCAL4 + - LOG_LOCAL5 + - LOG_LOCAL6 + - LOG_LOCAL7 oneOf: - type: object title: folder properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device tags: type: object @@ -7337,34 +7337,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device generic_error: type: object properties: @@ -7392,6 +7392,6 @@ components: - type: object help: type: string -security: - - scmToken: [] +security: + - scmToken: [] x-internal: false diff --git a/openapi-specs/scm/config/sase/operations/config-operations.yaml b/openapi-specs/scm/config/sase/operations/config-operations-latest.yaml similarity index 100% rename from openapi-specs/scm/config/sase/operations/config-operations.yaml rename to openapi-specs/scm/config/sase/operations/config-operations-latest.yaml diff --git a/openapi-specs/scm/config/sase/security/security-services-updated.yaml b/openapi-specs/scm/config/sase/security/security-services-latest.yaml similarity index 89% rename from openapi-specs/scm/config/sase/security/security-services-updated.yaml rename to openapi-specs/scm/config/sase/security/security-services-latest.yaml index fc38a5f9b..8361ca487 100644 --- a/openapi-specs/scm/config/sase/security/security-services-updated.yaml +++ b/openapi-specs/scm/config/sase/security/security-services-latest.yaml @@ -65,7 +65,7 @@ paths: summary: List anti-spyware profiles description: | Retrieve a list of anti-spyware profiles. - operationId: ListAnti-SpywareProfiles + operationId: ListAntiSpywareProfiles parameters: - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/folder' @@ -110,7 +110,7 @@ paths: summary: Create an anti-spyware profile description: | Create a new anti-spyware profile. - operationId: CreateAnti-SpywareProfiles + operationId: CreateAntiSpywareProfiles requestBody: description: Created content: @@ -141,7 +141,7 @@ paths: summary: Get an anti-spyware profile description: | Get an existing anti-spyware profile. - operationId: GetAnti-SpywareProfilesByID + operationId: GetAntiSpywareProfilesByID parameters: - $ref: '#/components/parameters/uuid' responses: @@ -167,7 +167,7 @@ paths: summary: Update an anti-spyware profile description: | Update an existing anti-spyware profile. - operationId: UpdateAnti-SpywareProfilesByID + operationId: UpdateAntiSpywareProfilesByID parameters: - $ref: '#/components/parameters/uuid' requestBody: @@ -201,7 +201,7 @@ paths: summary: Delete an anti-spyware profile description: | Delete an anti-spyware profile. - operationId: DeleteAnti-SpywareProfilesByID + operationId: DeleteAntiSpywareProfilesByID parameters: - $ref: '#/components/parameters/uuid' responses: @@ -226,9 +226,8 @@ paths: summary: List anti-spyware signatures description: | Retrieve a list of anti-spyware signatures. - operationId: ListAnti-SpywareSignatures + operationId: ListAntiSpywareSignatures parameters: - - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/folder' - $ref: '#/components/parameters/snippet' - $ref: '#/components/parameters/device' @@ -271,7 +270,7 @@ paths: summary: Create an anti-spyware signature description: | Create a new anti-spyware signature. - operationId: CreateAnti-SpywareSignatures + operationId: CreateAntiSpywareSignatures requestBody: description: Created content: @@ -302,7 +301,7 @@ paths: summary: Get an anti-spyware signature description: | Get an existing anti-spyware signature. - operationId: GetAnti-SpywareSignaturesByID + operationId: GetAntiSpywareSignaturesByID parameters: - $ref: '#/components/parameters/uuid' responses: @@ -328,7 +327,7 @@ paths: summary: Update an anti-spyware signature description: | Update an existing anti-spyware signature. - operationId: UpdateAnti-SpywareSignaturesByID + operationId: UpdateAntiSpywareSignaturesByID parameters: - $ref: '#/components/parameters/uuid' requestBody: @@ -362,7 +361,7 @@ paths: summary: Delete an anti-spyware signature description: | Delete an anti-spyware signature. - operationId: DeleteAnti-SpywareSignaturesByID + operationId: DeleteAntiSpywareSignaturesByID parameters: - $ref: '#/components/parameters/uuid' responses: @@ -592,10 +591,21 @@ paths: content: application/json: schema: - allOf: - - type: array - items: - $ref: '#/components/schemas/decryption-exclusions' + type: object + properties: + data: + allOf: + - type: array + items: + $ref: '#/components/schemas/decryption-exclusions' + limit: + type: integer + default: 200 + offset: + type: integer + default: 0 + total: + type: integer '400': $ref: '#/components/responses/bad_request_errors_basic' '401': @@ -652,7 +662,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/decryption-exclusions" + $ref: '#/components/schemas/decryption-exclusions' '400': $ref: '#/components/responses/bad_request_errors_basic' '401': @@ -2063,23 +2073,7 @@ paths: content: application/json: schema: - type: object - properties: - data: - allOf: - - type: array - items: - oneOf: - - $ref: '#/components/schemas/security-rules' - - $ref: '#/components/schemas/internet-rules' - limit: - type: integer - default: 200 - offset: - type: integer - default: 0 - total: - type: integer + $ref: '#/components/schemas/SecurityRuleListResponse' '400': $ref: '#/components/responses/bad_request_errors_basic' '401': @@ -2104,9 +2098,7 @@ paths: content: application/json: schema: - oneOf: - - $ref: '#/components/schemas/security-rules' - - $ref: '#/components/schemas/internet-rules' + $ref: '#/components/schemas/security-rules' responses: '200': description: OK @@ -2165,9 +2157,7 @@ paths: content: application/json: schema: - oneOf: - - $ref: '#/components/schemas/security-rules' - - $ref: '#/components/schemas/internet-rules' + $ref: '#/components/schemas/security-rules' responses: '200': description: OK @@ -2778,7 +2768,6 @@ paths: Retrieve a list of vulnerability protection signatures. operationId: ListVulnerabilityProtectionSignatures parameters: - - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/folder' - $ref: '#/components/parameters/snippet' - $ref: '#/components/parameters/device' @@ -2937,7 +2926,7 @@ paths: summary: List Wildfire and anti-virus profiles description: | Retrieve a list of WildFire and anti-virus profiles. - operationId: ListWildFireAnti-VirusProfiles + operationId: ListWildFireAntiVirusProfiles parameters: - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/folder' @@ -2982,7 +2971,7 @@ paths: summary: Create a WildFire and anti-virus profile description: | Create a new WildFire and anti-virus profile. - operationId: CreateWildFireAnti-VirusProfiles + operationId: CreateWildFireAntiVirusProfiles requestBody: description: Created content: @@ -3013,7 +3002,7 @@ paths: summary: Get a WildFire and anti-virus profile description: | Get an existing WildFire and anti-virus profile. - operationId: GetWildFireAnti-VirusProfilesByID + operationId: GetWildFireAntiVirusProfilesByID parameters: - $ref: '#/components/parameters/uuid' responses: @@ -3039,7 +3028,7 @@ paths: summary: Update a wildfire and antivirus profile description: | Update an existing WildFire and anti-virus profile. - operationId: UpdateWildFireAnti-VirusProfilesByID + operationId: UpdateWildFireAntiVirusProfilesByID parameters: - $ref: '#/components/parameters/uuid' requestBody: @@ -3073,7 +3062,7 @@ paths: summary: Delete a WildFire and anti-virus profile description: | Delete a WildFire and anti-virus profile. - operationId: DeleteWildFireAnti-VirusProfilesByID + operationId: DeleteWildFireAntiVirusProfilesByID parameters: - $ref: '#/components/parameters/uuid' responses: @@ -3251,7 +3240,7 @@ components: Tenant Service Group (TSG) ID. The resulting JWT access token should be attached to all API calls as a `Bearer` token in the `Authorization` header (ex. `Authorization: Bearer tokenstring`). - flows: + flows: clientCredentials: tokenUrl: https://auth.apps.paloaltonetworks.com/oauth2/access_token scopes: {} @@ -3613,6 +3602,7 @@ components: type: string action: type: object + description: anti spyware profiles rules default action oneOf: - type: object title: allow @@ -3646,9 +3636,11 @@ components: type: object - type: object title: block_ip + description: Antispyware profiles rules action block ip parent properties: block_ip: type: object + description: anti spyware profiles rules action block ip properties: track_by: enum: @@ -3669,43 +3661,57 @@ components: type: string category: enum: - - dns-proxy + - adns-adtracking + - adns-benign + - adns-c2 + - adns-ddns + - adns-dnsmisconfig + - adns-grayware + - adns-hijacking + - adns-malware + - adns-new-domain + - adns-parked + - adns-phishing + - adns-proxy + - adware + - any + - autogen - backdoor + - botnet + - browser-hijack + - command-and-control + - cryptominer - data-theft - - autogen - - spyware + - dns + - dns-adtracking + - dns-benign + - dns-c2 + - dns-ddns + - dns-grayware + - dns-malware + - dns-new-domain + - dns-parked + - dns-phishing + - dns-proxy - dns-security + - dns-wildfire + - domain-edl - downloader - - dns-phishing - - phishing-kit - - cryptominer + - fraud - hacktool - - dns-benign - - dns-wildfire - - botnet - - dns-grayware - inline-cloud-c2 - keylogger - - p2p-communication - - domain-edl - - webshell - - command-and-control - - dns-ddns - net-worm - - any - - tls-fingerprint - - dns-new-domain - - dns - - fraud - - dns-c2 - - adware + - p2p-communication + - phishing-kit - post-exploitation - - dns-malware - - browser-hijack - - dns-parked + - spyware + - tls-fingerprint + - webshell threat_name: type: string - minLength: 4 + minLength: 3 + default: any threat_exception: type: array items: @@ -3715,6 +3721,7 @@ components: type: string action: type: object + description: anti spyware profiles threat exception default action oneOf: - type: object title: default @@ -3753,9 +3760,11 @@ components: type: object - type: object title: block_ip + description: anti spyware profiles threat exception action block ip parent properties: block_ip: type: object + description: anti spyware profiles threat exception action block ip properties: track_by: enum: @@ -3774,6 +3783,7 @@ components: type: array items: type: object + description: anti spyware protection IP address to be exempted from threat exception properties: name: type: string @@ -3787,34 +3797,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device anti-spyware-signatures: type: object required: @@ -3845,6 +3855,7 @@ components: type: string default_action: type: object + description: anti spyware signature default action oneOf: - type: object title: allow @@ -3878,9 +3889,11 @@ components: type: object - type: object title: block_ip + description: anti spyware signature default action properties: block_ip: type: object + description: anti spyware signature block ip properties: track_by: enum: @@ -3908,12 +3921,14 @@ components: - informational signature: type: object + description: anti spyware signature oneOf: - type: object title: combination properties: combination: type: object + description: anti spyware signature combination properties: and_condition: type: array @@ -3936,6 +3951,7 @@ components: default: false time_attribute: type: object + description: anti spyware time attribute properties: interval: type: integer @@ -4078,34 +4094,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device app-override-rules: type: object required: @@ -4186,34 +4202,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device rule-based-move: type: object title: rule-based-move @@ -4257,34 +4273,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device decryption-profiles: type: object required: @@ -4428,34 +4444,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device decryption-rules: type: object required: @@ -4509,7 +4525,7 @@ components: type: array items: type: string - description: The destination services and/or service groups + description: The destination services and/or service groups source: type: array items: @@ -4574,41 +4590,41 @@ components: description: add the certificate name for SSL inbound inspection required: - ssl_inbound_inspection - description: The type of decryption + description: The type of decryption oneOf: - type: object title: folder properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device dns-security-profiles: type: object properties: @@ -4725,34 +4741,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device dos-protection-profiles: type: object required: @@ -4785,7 +4801,7 @@ components: tcp-syn: type: object required: - - enable + - enable properties: enable: type: boolean @@ -4828,7 +4844,7 @@ components: maximum: 21600 - title: syn-cookies required: - - syn-cookies + - syn-cookies properties: syn-cookies: type: object @@ -5041,34 +5057,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device dos-protection-rules: type: object required: @@ -5097,8 +5113,8 @@ components: description: Position relative to local device rules type: string enum: - - pre - - post + - pre + - post default: pre schedule: description: Schedule on which to enforce the rule @@ -5148,72 +5164,72 @@ components: description: The action to take on rule match type: object oneOf: - - title: deny - type: object - required: - - deny - properties: - deny: - type: object - default: {} - - title: allow - type: object - required: - - allow - properties: - allow: - type: object - default: {} - - title: protect - type: object - required: - - protect - properties: - protect: - type: object - default: {} + - title: deny + type: object + required: + - deny + properties: + deny: + type: object + default: {} + - title: allow + type: object + required: + - allow + properties: + allow: + type: object + default: {} + - title: protect + type: object + required: + - protect + properties: + protect: + type: object + default: {} protection: type: object oneOf: - - title: aggregate - required: - - aggregate - type: object - properties: - aggregate: - type: object - required: - - profile - properties: - profile: - description: Aggregate DoS protection profile - type: string - - title: classified - required: - - classified - type: object - properties: - classified: - type: object - required: - - classification-criteria - - profile - properties: - classification-criteria: - type: object - required: - - address - properties: - address: - description: Classification method - type: string - enum: - - source-ip-only - - destination-ip-only - - src-dest-ip-both - profile: - description: Classified DoS protection profile - type: string + - title: aggregate + required: + - aggregate + type: object + properties: + aggregate: + type: object + required: + - profile + properties: + profile: + description: Aggregate DoS protection profile + type: string + - title: classified + required: + - classified + type: object + properties: + classified: + type: object + required: + - classification-criteria + - profile + properties: + classification-criteria: + type: object + required: + - address + properties: + address: + description: Classification method + type: string + enum: + - source-ip-only + - destination-ip-only + - src-dest-ip-both + profile: + description: Classified DoS protection profile + type: string log_setting: description: Log forwarding profile name type: string @@ -5224,34 +5240,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device file-blocking-profiles: type: object required: @@ -5323,34 +5339,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device http-header-profiles: type: object required: @@ -5360,7 +5376,7 @@ components: type: string description: The UUID of the HTTP header profile readOnly: true - example: 123e4567-e89b-12d3-a456-426655440000 + example: 123e4567-e89b-12d3-a456-426655440000 name: type: string description: The name of the HTTP header profile @@ -5390,7 +5406,7 @@ components: description: A list of DNS domains items: type: string - example: + example: - '*.google.com' - 'gmail.com' headers: @@ -5431,34 +5447,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device profile-groups: type: object properties: @@ -5523,36 +5539,86 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device + # 1. THE UNIFIED, DISCRIMINATED SCHEMA + # This is the primary schema that all paths now reference. security-rules: type: object + description: |- + Represents a Security or Internet security rule. + A rule must be one of the policy types AND exist in one scope (folder, snippet, or device). + # Use allOf to combine multiple, independent constraints. + allOf: + # Constraint 1: The object must conform to one of the policy types. + - oneOf: + - $ref: '#/components/schemas/security-rule-type' + - $ref: '#/components/schemas/internet-rule-type' + discriminator: + propertyName: policy_type + mapping: + Security: '#/components/schemas/security-rule-type' + Internet: '#/components/schemas/internet-rule-type' + + # Constraint 2: The object must exist in exactly one scope. + - oneOf: + - type: object + required: [folder] + properties: + folder: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The folder in which the resource is defined + - type: object + required: [snippet] + properties: + snippet: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The snippet in which the resource is defined + - type: object + required: [device] + properties: + device: + type: string + pattern: ^[a-zA-Z\d\-_\. ]+$ + maxLength: 64 + description: The device in which the resource is defined + + # 2. A BASE SCHEMA FOR COMMON PROPERTIES + # This reduces duplication and clearly defines what is shared between rule types. + base-rule-properties: + type: object + required: + - name properties: id: type: string @@ -5563,6 +5629,9 @@ components: name: type: string description: The name of the security rule + policy_type: + type: string + default: 'Security' disabled: type: boolean description: Is the security rule disabled? @@ -5583,6 +5652,13 @@ components: items: type: string default: any + to: + type: array + description: The destination security zone(s) + uniqueItems: true + items: + type: string + default: any source: type: array description: The source addresses(es) @@ -5601,19 +5677,6 @@ components: items: type: string default: any - source_hip: - type: array - description: The source Host Integrity Profile(s) - items: - type: string - default: any - to: - type: array - description: The destination security zone(s) - uniqueItems: true - items: - type: string - default: any destination: type: array description: The destination address(es) @@ -5621,24 +5684,6 @@ components: items: type: string default: any - negate_destination: - type: boolean - description: Negate the destination addresses(es)? - default: false - destination_hip: - type: array - description: The destination Host Integrity Profile(s) - uniqueItems: true - items: - type: string - default: any - application: - type: array - description: The application(s) being accessed - uniqueItems: true - items: - type: string - default: any service: type: array description: The service(s) being accessed @@ -5646,13 +5691,9 @@ components: items: type: string default: any - category: - type: array - description: The URL categories being accessed - uniqueItems: true - items: - type: string - default: any + schedule: + type: string + description: Schedule in which this rule will be applied action: enum: - allow @@ -5662,294 +5703,304 @@ components: - reset-server - reset-both description: The action to be taken when the rule is matched - profile_setting: - type: object - description: The security profile object - properties: - group: - type: array - description: The security profile group - items: - type: string - default: best-practice - log_setting: - type: string - description: The external log forwarding profile - schedule: - type: string - description: Schedule in which this rule will be applied - log_start: - type: boolean - description: Log at session start? - log_end: - type: boolean - description: Log at session end? - tenant_restrictions: - type: array - items: - type: string - default: any + + # 3. THE "SECURITY" RULE VARIANT + # Contains the base properties plus fields unique to 'Security' rules. + security-rule-type: + type: object required: - - name - from + - to - source - source_user - - to - destination - - application - service - - category - action - oneOf: - - type: object - title: folder - properties: - folder: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The folder in which the resource is defined - example: My Folder - required: - - folder - - type: object - title: snippet - properties: - snippet: - type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The snippet in which the resource is defined - example: My Snippet - required: - - snippet + description: A standard security rule for controlling traffic between zones. + allOf: + - $ref: '#/components/schemas/base-rule-properties' - type: object - title: device + required: + - category + - application properties: - device: + negate_destination: + type: boolean + description: Negate the destination addresses(es)? + default: false + source_hip: + type: array + description: The source Host Integrity Profile(s) + items: + type: string + default: any + destination_hip: + type: array + description: The destination Host Integrity Profile(s) + uniqueItems: true + items: + type: string + default: any + application: + type: array + description: The application(s) being accessed + uniqueItems: true + items: + type: string + default: any + category: + type: array + description: The URL categories being accessed + uniqueItems: true + items: + type: string + default: any + action: + enum: + - allow + - deny + - drop + - reset-client + - reset-server + - reset-both + description: The action to be taken when the rule is matched + profile_setting: + type: object + description: The security profile object + properties: + group: + type: array + description: The security profile group + items: + type: string + default: best-practice + log_setting: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ - maxLength: 64 - description: The device in which the resource is defined - example: My Device - required: - - device - internet-rules: + description: The external log forwarding profile + log_start: + type: boolean + description: Log at session start? + log_end: + type: boolean + description: Log at session end? + tenant_restrictions: + type: array + items: + type: string + default: any + + # 4. THE "INTERNET" RULE VARIANT + # Contains the base properties plus fields unique to 'Internet' rules. + internet-rule-type: type: object - properties: - id: - type: string - description: The UUID of the internet rule - readOnly: true - example: 123e4567-e89b-12d3-a456-426655440000 - name: - type: string - description: The name of the internet rule - policy_type: - type: string - default: "Internet" - description: - type: string - description: The description of the internet rule - disabled: - type: boolean - description: Is the internet rule disabled? - default: false - log_settings: - type: object + description: A simplified security rule for controlling internet access. + allOf: + - $ref: '#/components/schemas/base-rule-properties' + - type: object properties: - log_sessions: + negate_user: type: boolean - default: true - tag: - type: array - items: - type: string - maxItems: 64 - from: - type: array - items: - type: string - default: ["any"] - to: - type: array - items: - type: string - default: ["any"] - source: - type: array - items: - type: string - default: ["any"] - source_user: - type: array - items: - type: string - default: ["any"] - destination: - type: array - items: - type: string - default: ["any"] - negate_source: - type: boolean - default: false - negate_user: - type: boolean - default: false - device: - type: array - items: - type: string - default: ["any"] - service: - type: array - items: - type: string - schedule: - type: string - action: - type: string - enum: [deny, allow] - default: allow - security_settings: - type: object - properties: - anti_spyware: - type: string - enum: [yes, no] - default: yes - vulnerability: - type: string - enum: [yes, no] - default: yes - virus_and_wildfire_analysis: - type: string - enum: [yes, no] - default: yes - block_web_application: - type: array - items: - type: string - block_url_category: - type: array - items: - type: string - allow_web_application: - type: array - items: - type: object - properties: - name: + default: false + devices: + type: array + items: type: string - type: + default: ['any'] + action: + enum: [allow, deny] + default: allow + log_settings: + type: object + properties: + log_sessions: + type: boolean + default: true + security_settings: + type: object + properties: + anti_spyware: + type: string + enum: [yes, no] + default: yes + vulnerability: + type: string + enum: [yes, no] + default: yes + virus_and_wildfire_analysis: + type: string + enum: [yes, no] + default: yes + block_web_application: + type: array + items: type: string - file_control: + block_url_category: + type: array + items: + type: string + allow_web_application: + type: array + items: type: object properties: - upload: + name: type: string - enum: [allow-all-file-types, best-practice, block-all-file-types] - download: + type: type: string - enum: [allow-all-file-types, best-practice, block-all-file-types] - saas_enterprise_control: - type: object - properties: - consumer_access: + file_control: type: object properties: - enable: + upload: type: string - enum: [yes, no] - enterprise_access: + enum: + [ + allow-all-file-types, + best-practice, + block-all-file-types, + ] + download: + type: string + enum: + [ + allow-all-file-types, + best-practice, + block-all-file-types, + ] + saas_enterprise_control: type: object properties: - enable: - type: string - enum: [yes, no] - tenant_restrictions: - type: array - items: - type: string - application_function: - type: array - items: - type: string - dlp: - type: string - saas_tenant_list: - type: array - items: - type: string - saas_user_list: - type: array - items: - type: string - tenant_control: - type: object - properties: - tenants: + consumer_access: + type: object + properties: + enable: + type: string + enum: [yes, no] + enterprise_access: + type: object + properties: + enable: + type: string + enum: [yes, no] + tenant_restrictions: + type: array + items: + type: string + application_function: type: array items: type: string - allowed_activities: + dlp: + type: string + saas_tenant_list: type: array items: type: string - blocked_activities: + saas_user_list: type: array items: type: string - parent_application: - type: string - allow_url_category: - type: array - items: - type: object - properties: - name: - type: string - decryption: - type: string - enum: [enabled, disabled] - default: enabled - credential_enforcement: - type: string - enum: [enabled, disabled] - default: enabled - additional_action: - type: string - enum: [none, continue, redirect, isolate] - default: none - isolation_profiles: - type: string - default: none - file_control: + tenant_control: + type: object + properties: + tenants: + type: array + items: + type: string + allowed_activities: + type: array + items: + type: string + blocked_activities: + type: array + items: + type: string + parent_application: + type: string + allow_url_category: + type: array + items: type: object properties: - upload: + name: type: string - enum: [allow-all-file-types, best-practice, block-all-file-types] - download: + decryption: type: string - enum: [allow-all-file-types, best-practice, block-all-file-types] - dlp: - type: string - default_profile_settings: - type: object - properties: - file_control: + enum: [enabled, disabled] + default: enabled + credential_enforcement: + type: string + enum: [enabled, disabled] + default: enabled + additional_action: + type: string + enum: [none, continue, redirect, isolate] + default: none + isolation_profiles: + type: string + default: none + file_control: + type: object + properties: + upload: + type: string + enum: + [ + allow-all-file-types, + best-practice, + block-all-file-types, + ] + download: + type: string + enum: + [ + allow-all-file-types, + best-practice, + block-all-file-types, + ] + dlp: + type: string + default_profile_settings: type: object properties: - upload: - type: string - enum: [allow-all-file-types, best-practice, block-all-file-types] - download: + file_control: + type: object + properties: + upload: + type: string + enum: + [ + allow-all-file-types, + best-practice, + block-all-file-types, + ] + download: + type: string + enum: + [ + allow-all-file-types, + best-practice, + block-all-file-types, + ] + dlp: type: string - enum: [allow-all-file-types, best-practice, block-all-file-types] - dlp: - type: string + + # 5. THE LIST RESPONSE SCHEMA + # This now points to the unified 'security-rules' schema. + SecurityRuleListResponse: + type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/security-rules' + limit: + type: integer + default: 200 + offset: + type: integer + default: 0 + total: + type: integer url-access-profiles: type: object properties: @@ -6047,37 +6098,42 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device url-categories: type: object properties: + id: + type: string + description: UUID of the resource + readOnly: true + example: 123e4567-e89b-12d3-a456-426655440000 name: type: string description: @@ -6099,34 +6155,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device url-filtering-categories: type: object properties: @@ -6154,6 +6210,7 @@ components: type: string action: type: object + description: vulnerability profiles threat exception default action oneOf: - type: object title: default @@ -6195,6 +6252,7 @@ components: properties: block_ip: type: object + description: vulnerability protection block ip properties: track_by: enum: @@ -6250,6 +6308,7 @@ components: type: string action: type: object + description: vulnerability threat exception default action oneOf: - type: object title: default @@ -6291,6 +6350,7 @@ components: properties: block_ip: type: object + description: vulnerability protection threat exception block ip properties: track_by: enum: @@ -6309,6 +6369,7 @@ components: type: array items: type: object + description: Vulnerability protection IP address to be exempted from threat exception properties: name: type: string @@ -6316,6 +6377,7 @@ components: - name time_attribute: type: object + description: vulnerability time attribute properties: interval: type: integer @@ -6342,34 +6404,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device vulnerability-protection-signatures: type: object properties: @@ -6379,10 +6441,8 @@ components: readOnly: true example: 123e4567-e89b-12d3-a456-426655440000 threat_id: - type: integer + type: string description: threat id range <41000-45000> and <6800001-6900000> - minimum: 41000 - maximum: 6900000 affected_host: type: object oneOf: @@ -6444,6 +6504,7 @@ components: title: block_ip properties: block_ip: + description: vulnerability protection bugtraq block ip type: object properties: track_by: @@ -6471,25 +6532,32 @@ components: - medium - informational signature: + description: vulnerability protection signature type: object oneOf: - type: object title: combination + description: vulnerability protection signature combination properties: combination: type: object + description: vulnerability protection signature combination object properties: and_condition: type: array + description: vulnerability protection signature combination object and condition items: type: object + description: vulnerability protection signature combination object and condition object properties: name: type: string or_condition: type: array + description: vulnerability protection signature combination object and condition object or condition items: type: object + description: vulnerability protection signature combination object and condition object or condition object properties: name: type: string @@ -6516,33 +6584,42 @@ components: - destination - type: object title: standard + description: vulnerability protection signature standard properties: standard: type: array + description: vulnerability protection signature standard array items: type: object + description: vulnerability protection signature standard object properties: name: type: string and_condition: type: array + description: vulnerability protection signature standard object and condition items: type: object + description: vulnerability protection signature standard object and condition object properties: name: type: string or_condition: type: array + description: vulnerability protection signature standard object and condition object or condition items: type: object + description: vulnerability protection signature standard object and condition object or condition object properties: name: type: string operator: type: object + description: vulnerability protection signature standard object and condition object or condition object operators properties: equal_to: type: object + description: vulnerability protection signature standard object and condition object or condition object operators equal_to properties: context: type: string @@ -6551,8 +6628,10 @@ components: default: false qualifier: type: array + description: vulnerability protection signature standard object and condition object or condition object operators equal_to qualifier array items: type: object + description: vulnerability protection signature standard object and condition object or condition object operators equal_to qualifier array object properties: name: type: string @@ -6564,13 +6643,16 @@ components: maximum: 4294967295 greater_than: type: object + description: vulnerability protection signature standard object and condition object or condition object operators greater_than properties: context: type: string qualifier: type: array + description: vulnerability protection signature standard object and condition object or condition object operators greater_than qualifier items: type: object + description: vulnerability protection signature standard object and condition object or condition object operators greater_than qualifier object properties: name: type: string @@ -6582,13 +6664,16 @@ components: maximum: 4294967295 less_than: type: object + description: vulnerability protection signature standard object and condition object or condition object operators less_than properties: context: type: string qualifier: type: array + description: vulnerability protection signature standard object and condition object or condition object operators less_than array items: type: object + description: vulnerability protection signature standard object and condition object or condition object operators less_than array object properties: name: type: string @@ -6600,6 +6685,7 @@ components: maximum: 4294967295 pattern_match: type: object + description: vulnerability protection signature standard object and condition object or condition object operators pattern match properties: context: type: string @@ -6610,8 +6696,10 @@ components: type: string qualifier: type: array + description: vulnerability protection signature standard object and condition object or condition object operators pattern match qualifier items: type: object + description: vulnerability protection signature standard object and condition object or condition object operators pattern match qualifier object properties: name: type: string @@ -6645,34 +6733,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device wildfire-anti-virus-profiles: type: object properties: @@ -6740,34 +6828,34 @@ components: properties: folder: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The folder in which the resource is defined example: My Folder - required: - - folder + required: + - folder - type: object title: snippet properties: snippet: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The snippet in which the resource is defined example: My Snippet - required: - - snippet + required: + - snippet - type: object title: device properties: device: type: string - pattern: ^[a-zA-Z\d-_\. ]+$ + pattern: ^[a-zA-Z\d\-_\. ]+$ maxLength: 64 description: The device in which the resource is defined example: My Device - required: - - device + required: + - device saas-tenant-restrictions: type: object properties: diff --git a/openapi-specs/scm/config/sase/setup/config-setup-updated.yaml b/openapi-specs/scm/config/sase/setup/config-setup-latest.yaml similarity index 98% rename from openapi-specs/scm/config/sase/setup/config-setup-updated.yaml rename to openapi-specs/scm/config/sase/setup/config-setup-latest.yaml index b673b94ea..424e0e45c 100644 --- a/openapi-specs/scm/config/sase/setup/config-setup-updated.yaml +++ b/openapi-specs/scm/config/sase/setup/config-setup-latest.yaml @@ -189,11 +189,7 @@ paths: - $ref: '#/components/parameters/uuid' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/labels' - description: OK + $ref: '#/components/responses/http_ok' '400': $ref: '#/components/responses/bad_request_errors_basic' '401': @@ -358,11 +354,7 @@ paths: - $ref: '#/components/parameters/uuid' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/variables' - description: OK + $ref: '#/components/responses/http_ok' '400': $ref: '#/components/responses/bad_request_errors_basic' '401': @@ -520,11 +512,7 @@ paths: - $ref: '#/components/parameters/uuid' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/snippets' - description: OK + $ref: '#/components/responses/http_ok' '400': $ref: '#/components/responses/bad_request_errors_basic' '401': @@ -881,11 +869,7 @@ paths: - $ref: '#/components/parameters/uuid' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/snippet_categories' - description: OK + $ref: '#/components/responses/http_ok' '400': $ref: '#/components/responses/bad_request_errors_basic' '401': @@ -995,13 +979,7 @@ paths: - $ref: '#/components/parameters/trusted-tenant-type' responses: '200': - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/tenant_trust_info' - description: OK + $ref: '#/components/responses/http_ok' '400': $ref: '#/components/responses/bad_request_errors_basic' '401': @@ -1149,11 +1127,7 @@ paths: - $ref: '#/components/parameters/recipient-tsgs' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/deleted_subscriber' - description: OK + $ref: '#/components/responses/http_ok' '400': $ref: '#/components/responses/bad_request_errors_basic' '401':