getNatPolicy

panos 2.0.11, Apr 28 26

Viewing docs for panos 2.0.11
published on Tuesday, Apr 28, 2026 by paloaltonetworks

paloaltonetworks/terraform-provider-panos

Viewing docs for panos 2.0.11
published on Tuesday, Apr 28, 2026 by paloaltonetworks

paloaltonetworks/terraform-provider-panos

Using getNatPolicy

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getNatPolicy(args: GetNatPolicyArgs, opts?: InvokeOptions): Promise<GetNatPolicyResult>
function getNatPolicyOutput(args: GetNatPolicyOutputArgs, opts?: InvokeOptions): Output<GetNatPolicyResult>

def get_nat_policy(location: Optional[GetNatPolicyLocation] = None,
                   rules: Optional[Sequence[GetNatPolicyRule]] = None,
                   opts: Optional[InvokeOptions] = None) -> GetNatPolicyResult
def get_nat_policy_output(location: Optional[pulumi.Input[GetNatPolicyLocationArgs]] = None,
                   rules: Optional[pulumi.Input[Sequence[pulumi.Input[GetNatPolicyRuleArgs]]]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetNatPolicyResult]

func LookupNatPolicy(ctx *Context, args *LookupNatPolicyArgs, opts ...InvokeOption) (*LookupNatPolicyResult, error)
func LookupNatPolicyOutput(ctx *Context, args *LookupNatPolicyOutputArgs, opts ...InvokeOption) LookupNatPolicyResultOutput

> Note: This function is named LookupNatPolicy in the Go SDK.

public static class GetNatPolicy 
{
    public static Task<GetNatPolicyResult> InvokeAsync(GetNatPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetNatPolicyResult> Invoke(GetNatPolicyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNatPolicyResult> getNatPolicy(GetNatPolicyArgs args, InvokeOptions options)
public static Output<GetNatPolicyResult> getNatPolicy(GetNatPolicyArgs args, InvokeOptions options)

fn::invoke:
  function: panos:index/getNatPolicy:getNatPolicy
  arguments:
    # arguments dictionary

The following arguments are supported:

Location GetNatPolicyLocation: The location of this object.
Rules List<GetNatPolicyRule>

Location GetNatPolicyLocation: The location of this object.
Rules []GetNatPolicyRule

location GetNatPolicyLocation: The location of this object.
rules List<GetNatPolicyRule>

location GetNatPolicyLocation: The location of this object.
rules GetNatPolicyRule[]

location GetNatPolicyLocation: The location of this object.
rules Sequence[GetNatPolicyRule]

location Property Map: The location of this object.
rules List<Property Map>

getNatPolicy Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Location GetNatPolicyLocation: The location of this object.
Rules List<GetNatPolicyRule>

Id string: The provider-assigned unique ID for this managed resource.
Location GetNatPolicyLocation: The location of this object.
Rules []GetNatPolicyRule

id String: The provider-assigned unique ID for this managed resource.
location GetNatPolicyLocation: The location of this object.
rules List<GetNatPolicyRule>

id string: The provider-assigned unique ID for this managed resource.
location GetNatPolicyLocation: The location of this object.
rules GetNatPolicyRule[]

id str: The provider-assigned unique ID for this managed resource.
location GetNatPolicyLocation: The location of this object.
rules Sequence[GetNatPolicyRule]

id String: The provider-assigned unique ID for this managed resource.
location Property Map: The location of this object.
rules List<Property Map>

Supporting Types

GetNatPolicyLocation

DeviceGroup GetNatPolicyLocationDeviceGroup: Located in a specific device group rulebase
Shared GetNatPolicyLocationShared: Located in a shared rulebase
Vsys GetNatPolicyLocationVsys: Located in a specific vsys rulebase

DeviceGroup GetNatPolicyLocationDeviceGroup: Located in a specific device group rulebase
Shared GetNatPolicyLocationShared: Located in a shared rulebase
Vsys GetNatPolicyLocationVsys: Located in a specific vsys rulebase

deviceGroup GetNatPolicyLocationDeviceGroup: Located in a specific device group rulebase
shared GetNatPolicyLocationShared: Located in a shared rulebase
vsys GetNatPolicyLocationVsys: Located in a specific vsys rulebase

deviceGroup GetNatPolicyLocationDeviceGroup: Located in a specific device group rulebase
shared GetNatPolicyLocationShared: Located in a shared rulebase
vsys GetNatPolicyLocationVsys: Located in a specific vsys rulebase

device_group GetNatPolicyLocationDeviceGroup: Located in a specific device group rulebase
shared GetNatPolicyLocationShared: Located in a shared rulebase
vsys GetNatPolicyLocationVsys: Located in a specific vsys rulebase

deviceGroup Property Map: Located in a specific device group rulebase
shared Property Map: Located in a shared rulebase
vsys Property Map: Located in a specific vsys rulebase

GetNatPolicyLocationDeviceGroup

Name string: The device group name
PanoramaDevice string: The panorama device
Rulebase string: The rulebase

Name string: The device group name
PanoramaDevice string: The panorama device
Rulebase string: The rulebase

name String: The device group name
panoramaDevice String: The panorama device
rulebase String: The rulebase

name string: The device group name
panoramaDevice string: The panorama device
rulebase string: The rulebase

name str: The device group name
panorama_device str: The panorama device
rulebase str: The rulebase

name String: The device group name
panoramaDevice String: The panorama device
rulebase String: The rulebase

GetNatPolicyLocationShared

Rulebase string: Rulebase name

Rulebase string: Rulebase name

rulebase String: Rulebase name

rulebase string: Rulebase name

rulebase str: Rulebase name

rulebase String: Rulebase name

GetNatPolicyLocationVsys

Name string: The vsys name
NgfwDevice string: The NGFW device

Name string: The vsys name
NgfwDevice string: The NGFW device

name String: The vsys name
ngfwDevice String: The NGFW device

name string: The vsys name
ngfwDevice string: The NGFW device

name str: The vsys name
ngfw_device str: The NGFW device

name String: The vsys name
ngfwDevice String: The NGFW device

GetNatPolicyRule

ActiveActiveDeviceBinding string: Device binding configuration in HA Active-Active mode
AuditCommentVersion string: Version trigger for audit comments. Change this value to send the auditcommentwo to PAN-OS. This attribute is not sent to PAN-OS itself, but serves as a trigger to detect when the audit comment should be updated.
Description string
DestinationAddresses List<string>
DestinationTranslation GetNatPolicyRuleDestinationTranslation
DestinationZones List<string>
Disabled bool: Disable the rule
DynamicDestinationTranslation GetNatPolicyRuleDynamicDestinationTranslation
GroupTag string
Name string
NatType string: type of nat
Service string
SourceAddresses List<string>
SourceTranslation GetNatPolicyRuleSourceTranslation
SourceZones List<string>
Tags List<string>
Target GetNatPolicyRuleTarget
ToInterface string: Egress interface from route lookup

ActiveActiveDeviceBinding string: Device binding configuration in HA Active-Active mode
AuditCommentVersion string: Version trigger for audit comments. Change this value to send the auditcommentwo to PAN-OS. This attribute is not sent to PAN-OS itself, but serves as a trigger to detect when the audit comment should be updated.
Description string
DestinationAddresses []string
DestinationTranslation GetNatPolicyRuleDestinationTranslation
DestinationZones []string
Disabled bool: Disable the rule
DynamicDestinationTranslation GetNatPolicyRuleDynamicDestinationTranslation
GroupTag string
Name string
NatType string: type of nat
Service string
SourceAddresses []string
SourceTranslation GetNatPolicyRuleSourceTranslation
SourceZones []string
Tags []string
Target GetNatPolicyRuleTarget
ToInterface string: Egress interface from route lookup

activeActiveDeviceBinding String: Device binding configuration in HA Active-Active mode
auditCommentVersion String: Version trigger for audit comments. Change this value to send the auditcommentwo to PAN-OS. This attribute is not sent to PAN-OS itself, but serves as a trigger to detect when the audit comment should be updated.
description String
destinationAddresses List<String>
destinationTranslation GetNatPolicyRuleDestinationTranslation
destinationZones List<String>
disabled Boolean: Disable the rule
dynamicDestinationTranslation GetNatPolicyRuleDynamicDestinationTranslation
groupTag String
name String
natType String: type of nat
service String
sourceAddresses List<String>
sourceTranslation GetNatPolicyRuleSourceTranslation
sourceZones List<String>
tags List<String>
target GetNatPolicyRuleTarget
toInterface String: Egress interface from route lookup

activeActiveDeviceBinding string: Device binding configuration in HA Active-Active mode
auditCommentVersion string: Version trigger for audit comments. Change this value to send the auditcommentwo to PAN-OS. This attribute is not sent to PAN-OS itself, but serves as a trigger to detect when the audit comment should be updated.
description string
destinationAddresses string[]
destinationTranslation GetNatPolicyRuleDestinationTranslation
destinationZones string[]
disabled boolean: Disable the rule
dynamicDestinationTranslation GetNatPolicyRuleDynamicDestinationTranslation
groupTag string
name string
natType string: type of nat
service string
sourceAddresses string[]
sourceTranslation GetNatPolicyRuleSourceTranslation
sourceZones string[]
tags string[]
target GetNatPolicyRuleTarget
toInterface string: Egress interface from route lookup

active_active_device_binding str: Device binding configuration in HA Active-Active mode
audit_comment_version str: Version trigger for audit comments. Change this value to send the auditcommentwo to PAN-OS. This attribute is not sent to PAN-OS itself, but serves as a trigger to detect when the audit comment should be updated.
description str
destination_addresses Sequence[str]
destination_translation GetNatPolicyRuleDestinationTranslation
destination_zones Sequence[str]
disabled bool: Disable the rule
dynamic_destination_translation GetNatPolicyRuleDynamicDestinationTranslation
group_tag str
name str
nat_type str: type of nat
service str
source_addresses Sequence[str]
source_translation GetNatPolicyRuleSourceTranslation
source_zones Sequence[str]
tags Sequence[str]
target GetNatPolicyRuleTarget
to_interface str: Egress interface from route lookup

activeActiveDeviceBinding String: Device binding configuration in HA Active-Active mode
auditCommentVersion String: Version trigger for audit comments. Change this value to send the auditcommentwo to PAN-OS. This attribute is not sent to PAN-OS itself, but serves as a trigger to detect when the audit comment should be updated.
description String
destinationAddresses List<String>
destinationTranslation Property Map
destinationZones List<String>
disabled Boolean: Disable the rule
dynamicDestinationTranslation Property Map
groupTag String
name String
natType String: type of nat
service String
sourceAddresses List<String>
sourceTranslation Property Map
sourceZones List<String>
tags List<String>
target Property Map
toInterface String: Egress interface from route lookup