RemoteNetworksReadResult

{
  "$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-read-result-schema.json",
  "title": "RemoteNetworksReadResult",
  "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/RemoteNetworksReadResult",
  "properties": {
    "configuration": {
      "$ref": "#/$defs/RemoteNetworksConfiguration"
    },
    "error": {
      "additionalProperties": true,
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "networkDetails": {
      "$ref": "#/$defs/RemoteNetworksIpsecTunnelResponse"
    },
    "status": {
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object",
  "$defs": {
    "RemoteNetworksConfiguration": {
      "properties": {
        "ecmp_load_balancing": {
          "default": "disable",
          "enum": [
            "enable",
            "disable"
          ],
          "type": "string"
        },
        "ecmp_tunnels": {
          "description": "ecmp_tunnels is required when ecmp_load_balancing is enable",
          "items": {
            "properties": {
              "ipsec_tunnel": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "protocol": {
                "properties": {
                  "bgp": {
                    "$ref": "#/$defs/RemoteNetworksProtocolBgp"
                  }
                },
                "type": "object"
              }
            },
            "required": [
              "name",
              "ipsec_tunnel",
              "protocol"
            ],
            "type": "object"
          },
          "maxLength": 4,
          "type": "array"
        },
        "id": {
          "description": "uuid of the resource",
          "readOnly": true,
          "type": "string"
        },
        "inbound_access": {
          "properties": {
            "applications": {
              "items": {
                "properties": {
                  "dedicated_ip": {
                    "default": false,
                    "description": "Dedicated IP address for this application",
                    "type": "boolean"
                  },
                  "port": {
                    "description": "Destination port",
                    "maximum": 65535,
                    "minimum": 1,
                    "type": "integer"
                  },
                  "private_ip": {
                    "description": "Private IP address",
                    "type": "string"
                  },
                  "protocol": {
                    "description": "Protocol used by this application",
                    "enum": [
                      "TCP",
                      "UDP"
                    ],
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "type": "array"
            },
            "enabled": {
              "default": false,
              "description": "Enable Inbound Access",
              "type": "boolean"
            },
            "public_ip": {
              "default": 5,
              "enum": [
                5,
                10
              ],
              "type": "string"
            },
            "snat_enabled": {
              "default": true,
              "description": "Enable source NAT",
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "ipsec_tunnel": {
          "description": "ipsec_tunnel is required when ecmp_load_balancing is disable",
          "type": "string"
        },
        "license_type": {
          "default": "FWAAS-AGGREGATE",
          "description": "New customer will only be on aggregate bandwidth licensing",
          "minLength": 1,
          "type": "string"
        },
        "name": {
          "description": "Alphanumeric string begin with letter: [0-9a-zA-Z._-]",
          "maxLength": 63,
          "type": "string"
        },
        "override_spn_name": {
          "default": false,
          "description": "Enable/disable the ability to override the remote-network's spn-name at site level",
          "type": "boolean"
        },
        "protocol": {
          "description": "setup the protocol when ecmp_load_balancing is disable",
          "properties": {
            "bgp": {
              "$ref": "#/$defs/RemoteNetworksProtocolBgp"
            },
            "bgp_peer": {
              "description": "secondary bgp routing as bgp_peer",
              "properties": {
                "local_ip_address": {
                  "type": "string"
                },
                "peer_ip_address": {
                  "type": "string"
                },
                "secret": {
                  "type": "string"
                }
              },
              "type": "object"
            }
          },
          "type": "object"
        },
        "region": {
          "minLength": 1,
          "type": "string"
        },
        "secondary_ipsec_tunnel": {
          "description": "specify secondary ipsec_tunnel if needed",
          "type": "string"
        },
        "spn_name": {
          "description": "spn-name is needed when license_type is FWAAS-AGGREGATE",
          "type": "string"
        },
        "subnets": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "name",
        "region",
        "license_type"
      ],
      "type": "object"
    },
    "RemoteNetworksIpsecTunnelResponse": {
      "properties": {
        "name": {
          "description": "rn name",
          "type": "string"
        },
        "pre_shared_key": {
          "description": "Pre Shared Key for the Ipsec Tunnel",
          "type": "string"
        },
        "service_ip": {
          "description": "Service Ip for the provisioned remote network tunnel",
          "format": "ipv4",
          "type": "string"
        },
        "tunnel_id": {
          "description": "tunnel id",
          "type": "string"
        }
      },
      "type": "object"
    },
    "RemoteNetworksProtocolBgp": {
      "properties": {
        "do_not_export_routes": {
          "type": "boolean"
        },
        "enable": {
          "description": "To setup bgp protocol, enable need to set as true",
          "type": "boolean"
        },
        "local_ip_address": {
          "type": "string"
        },
        "originate_default_route": {
          "type": "boolean"
        },
        "peer_as": {
          "type": "string"
        },
        "peer_ip_address": {
          "type": "string"
        },
        "peering_type": {
          "description": "Exchange Routes: exchange-v4-over-v4 stands for Exchange IPv4 routes over IPv4 peering. exchange-v4-v6-over-v4 stands for Exchange both IPv4 and IPv6 routes over IPv4 peering. exchange-v4-over-v4-v6-over-v6 stands for Exchange IPv4 routes over IPv4 peer and IPv6 route over IPv6 peer. exchange-v6-over-v6 stands for Exchange IPv6 routes over IPv6 peering.",
          "enum": [
            "exchange-v4-over-v4",
            "exchange-v4-v6-over-v4",
            "exchange-v4-over-v4-v6-over-v6",
            "exchange-v6-over-v6"
          ],
          "type": "string"
        },
        "secret": {
          "type": "string"
        },
        "summarize_mobile_user_routes": {
          "type": "boolean"
        }
      },
      "type": "object"
    }
  }
}