remote-networks

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/main/json-schema/palo-alto-networks-remote-networks-schema.json",
  "title": "remote-networks",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/palo-alto-networks-remote-networks-api-openapi.yml#/components/schemas/remote-networks",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The UUID of the remote network",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "The name of the remote network",
      "maxLength": 63
    },
    "folder": {
      "type": "string",
      "description": "The folder that contains the remote network",
      "default": "Remote Networks"
    },
    "ipsec_tunnel": {
      "type": "string",
      "description": "ipsec_tunnel is required when ecmp_load_balancing is disable"
    },
    "secondary_ipsec_tunnel": {
      "type": "string",
      "description": "specify secondary ipsec_tunnel if needed"
    },
    "license_type": {
      "type": "string",
      "description": "New customer will only be on aggregate bandwidth licensing",
      "minLength": 1,
      "default": "FWAAS-AGGREGATE"
    },
    "region": {
      "type": "string",
      "minLength": 1
    },
    "subnets": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "protocol": {
      "type": "object",
      "description": "setup the protocol when ecmp_load_balancing is disable",
      "properties": {
        "bgp": {
          "$ref": "#/$defs/remote-networks-protocol-bgp"
        },
        "bgp_peer": {
          "type": "object",
          "description": "secondary bgp routing as bgp_peer",
          "properties": {
            "same_as_primary": {
              "description": "Same peer IP address as primary WAN",
              "type": "boolean"
            },
            "peer_ip_address": {
              "description": "Remote peer IP address (secondary WAN)",
              "type": "string"
            },
            "local_ip_address": {
              "description": "Local peer IP address (secondary WAN)",
              "type": "string"
            },
            "secret": {
              "description": "BGP peering secret (secondary WAN)",
              "type": "string",
              "format": "password"
            }
          }
        }
      }
    },
    "spn_name": {
      "type": "string",
      "description": "spn-name is needed when license_type is FWAAS-AGGREGATE"
    },
    "ecmp_load_balancing": {
      "type": "string",
      "enum": [
        "enable",
        "disable"
      ],
      "default": "disable"
    },
    "ecmp_tunnels": {
      "type": "array",
      "description": "ecmp_tunnels is required when ecmp_load_balancing is enable",
      "items": {
        "maxItems": 4,
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "ipsec_tunnel": {
            "type": "string"
          },
          "protocol": {
            "type": "object",
            "properties": {
              "bgp": {
                "$ref": "#/$defs/remote-networks-protocol-bgp"
              }
            }
          }
        },
        "required": [
          "name",
          "ipsec_tunnel",
          "protocol"
        ]
      }
    }
  },
  "required": [
    "id",
    "name",
    "folder",
    "license_type",
    "region"
  ],
  "$defs": {
    "remote-networks-protocol-bgp": {
      "type": "object",
      "properties": {
        "enable": {
          "description": "Enable BGP peering?",
          "type": "boolean"
        },
        "summarize_mobile_user_routes": {
          "description": "Summarize mobile user routes?",
          "type": "boolean"
        },
        "originate_default_route": {
          "description": "Originate default route?",
          "type": "boolean"
        },
        "do_not_export_routes": {
          "description": "Do not export routes?",
          "type": "boolean"
        },
        "peer_ip_address": {
          "description": "Remote peer IP address",
          "type": "string"
        },
        "peer_as": {
          "description": "BGP peer ASN",
          "type": "string"
        },
        "local_ip_address": {
          "description": "Local peer IP address",
          "type": "string"
        },
        "secret": {
          "description": "BGP peering secret",
          "type": "string",
          "format": "password"
        },
        "peering_type": {
          "description": "Route exchange types",
          "type": "string",
          "enum": [
            "exchange-v4-over-v4",
            "exchange-v4-v6-over-v4",
            "exchange-v4-over-v4-v6-over-v6",
            "exchange-v6-over-v6"
          ]
        }
      }
    }
  }
}