Palo Alto Networks · Schema

NatRule

A NAT policy rule defining source or destination address translation for matching traffic.

Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

Properties

Name Type Description
@name string Unique name of the NAT rule.
from object
to object
source object
destination object
service string Service object or any.
source-translation object Source address translation settings.
destination-translation object Destination address translation settings.
nat-type string
disabled string
description string
tag object
View JSON Schema on GitHub

JSON Schema

pan-os-rest-api-nat-rule-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "NatRule",
  "description": "A NAT policy rule defining source or destination address translation for matching traffic.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/pan-os-rest-api-nat-rule-schema.json",
  "type": "object",
  "properties": {
    "@name": {
      "type": "string",
      "description": "Unique name of the NAT rule."
    },
    "from": {
      "type": "object",
      "properties": {
        "member": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Source zones."
        }
      }
    },
    "to": {
      "type": "object",
      "properties": {
        "member": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Destination zones."
        }
      }
    },
    "source": {
      "type": "object",
      "properties": {
        "member": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Source addresses."
        }
      }
    },
    "destination": {
      "type": "object",
      "properties": {
        "member": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Destination addresses."
        }
      }
    },
    "service": {
      "type": "string",
      "description": "Service object or any."
    },
    "source-translation": {
      "type": "object",
      "description": "Source address translation settings.",
      "properties": {
        "dynamic-ip-and-port": {
          "type": "object",
          "properties": {
            "interface-address": {
              "type": "object",
              "properties": {
                "interface": {
                  "type": "string"
                }
              }
            },
            "translated-address": {
              "type": "object",
              "properties": {
                "member": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "static-ip": {
          "type": "object",
          "properties": {
            "translated-address": {
              "type": "string"
            },
            "bi-directional": {
              "type": "string",
              "enum": [
                "yes",
                "no"
              ]
            }
          }
        }
      }
    },
    "destination-translation": {
      "type": "object",
      "description": "Destination address translation settings.",
      "properties": {
        "translated-address": {
          "type": "string"
        },
        "translated-port": {
          "type": "string"
        }
      }
    },
    "nat-type": {
      "type": "string",
      "enum": [
        "ipv4",
        "nat64",
        "nptv6"
      ]
    },
    "disabled": {
      "type": "string",
      "enum": [
        "yes",
        "no"
      ]
    },
    "description": {
      "type": "string"
    },
    "tag": {
      "type": "object",
      "properties": {
        "member": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}