1. Packages
  2. Packages
  3. Panos Provider
  4. API Docs
  5. getPbfPolicy
Viewing docs for panos 2.0.11
published on Tuesday, Apr 28, 2026 by paloaltonetworks
Schema (JSON)
paloaltonetworks/terraform-provider-panos

panos.getPbfPolicy

Viewing docs for panos 2.0.11
published on Tuesday, Apr 28, 2026 by paloaltonetworks
Schema (JSON)
paloaltonetworks/terraform-provider-panos

    Using getPbfPolicy

    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 getPbfPolicy(args: GetPbfPolicyArgs, opts?: InvokeOptions): Promise<GetPbfPolicyResult>
function getPbfPolicyOutput(args: GetPbfPolicyOutputArgs, opts?: InvokeOptions): Output<GetPbfPolicyResult>
    def get_pbf_policy(location: Optional[GetPbfPolicyLocation] = None,
                   rules: Optional[Sequence[GetPbfPolicyRule]] = None,
                   opts: Optional[InvokeOptions] = None) -> GetPbfPolicyResult
def get_pbf_policy_output(location: Optional[pulumi.Input[GetPbfPolicyLocationArgs]] = None,
                   rules: Optional[pulumi.Input[Sequence[pulumi.Input[GetPbfPolicyRuleArgs]]]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetPbfPolicyResult]
    func LookupPbfPolicy(ctx *Context, args *LookupPbfPolicyArgs, opts ...InvokeOption) (*LookupPbfPolicyResult, error)
func LookupPbfPolicyOutput(ctx *Context, args *LookupPbfPolicyOutputArgs, opts ...InvokeOption) LookupPbfPolicyResultOutput

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

    public static class GetPbfPolicy 
{
    public static Task<GetPbfPolicyResult> InvokeAsync(GetPbfPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetPbfPolicyResult> Invoke(GetPbfPolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPbfPolicyResult> getPbfPolicy(GetPbfPolicyArgs args, InvokeOptions options)
public static Output<GetPbfPolicyResult> getPbfPolicy(GetPbfPolicyArgs args, InvokeOptions options)

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

    The following arguments are supported:

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

    getPbfPolicy Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Location GetPbfPolicyLocation
    The location of this object.
    Rules List<GetPbfPolicyRule>
    Id string
    The provider-assigned unique ID for this managed resource.
    Location GetPbfPolicyLocation
    The location of this object.
    Rules []GetPbfPolicyRule
    id String
    The provider-assigned unique ID for this managed resource.
    location GetPbfPolicyLocation
    The location of this object.
    rules List<GetPbfPolicyRule>
    id string
    The provider-assigned unique ID for this managed resource.
    location GetPbfPolicyLocation
    The location of this object.
    rules GetPbfPolicyRule[]
    id str
    The provider-assigned unique ID for this managed resource.
    location GetPbfPolicyLocation
    The location of this object.
    rules Sequence[GetPbfPolicyRule]
    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

    GetPbfPolicyLocation

    DeviceGroup GetPbfPolicyLocationDeviceGroup
    Located in a specific device group rulebase
    Shared GetPbfPolicyLocationShared
    Located in a shared rulebase
    Vsys GetPbfPolicyLocationVsys
    Located in a specific vsys rulebase
    DeviceGroup GetPbfPolicyLocationDeviceGroup
    Located in a specific device group rulebase
    Shared GetPbfPolicyLocationShared
    Located in a shared rulebase
    Vsys GetPbfPolicyLocationVsys
    Located in a specific vsys rulebase
    deviceGroup GetPbfPolicyLocationDeviceGroup
    Located in a specific device group rulebase
    shared GetPbfPolicyLocationShared
    Located in a shared rulebase
    vsys GetPbfPolicyLocationVsys
    Located in a specific vsys rulebase
    deviceGroup GetPbfPolicyLocationDeviceGroup
    Located in a specific device group rulebase
    shared GetPbfPolicyLocationShared
    Located in a shared rulebase
    vsys GetPbfPolicyLocationVsys
    Located in a specific vsys rulebase
    device_group GetPbfPolicyLocationDeviceGroup
    Located in a specific device group rulebase
    shared GetPbfPolicyLocationShared
    Located in a shared rulebase
    vsys GetPbfPolicyLocationVsys
    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

    GetPbfPolicyLocationDeviceGroup

    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

    GetPbfPolicyLocationShared

    Rulebase string
    Rulebase name
    Rulebase string
    Rulebase name
    rulebase String
    Rulebase name
    rulebase string
    Rulebase name
    rulebase str
    Rulebase name
    rulebase String
    Rulebase name

    GetPbfPolicyLocationVsys

    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

    GetPbfPolicyRule

    Action GetPbfPolicyRuleAction
    ActiveActiveDeviceBinding string
    Device binding configuration in HA Active-Active mode
    Applications List<string>
    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>
    Disabled bool
    Disable the rule
    EnforceSymmetricReturn GetPbfPolicyRuleEnforceSymmetricReturn
    From GetPbfPolicyRuleFrom
    GroupTag string
    Name string
    NegateDestination bool
    NegateSource bool
    Schedule string
    Services List<string>
    SourceAddresses List<string>
    SourceUsers List<string>
    Tags List<string>
    Target GetPbfPolicyRuleTarget
    Action GetPbfPolicyRuleAction
    ActiveActiveDeviceBinding string
    Device binding configuration in HA Active-Active mode
    Applications []string
    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
    Disabled bool
    Disable the rule
    EnforceSymmetricReturn GetPbfPolicyRuleEnforceSymmetricReturn
    From GetPbfPolicyRuleFrom
    GroupTag string
    Name string
    NegateDestination bool
    NegateSource bool
    Schedule string
    Services []string
    SourceAddresses []string
    SourceUsers []string
    Tags []string
    Target GetPbfPolicyRuleTarget
    action GetPbfPolicyRuleAction
    activeActiveDeviceBinding String
    Device binding configuration in HA Active-Active mode
    applications List<String>
    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>
    disabled Boolean
    Disable the rule
    enforceSymmetricReturn GetPbfPolicyRuleEnforceSymmetricReturn
    from GetPbfPolicyRuleFrom
    groupTag String
    name String
    negateDestination Boolean
    negateSource Boolean
    schedule String
    services List<String>
    sourceAddresses List<String>
    sourceUsers List<String>
    tags List<String>
    target GetPbfPolicyRuleTarget
    action GetPbfPolicyRuleAction
    activeActiveDeviceBinding string
    Device binding configuration in HA Active-Active mode
    applications string[]
    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[]
    disabled boolean
    Disable the rule
    enforceSymmetricReturn GetPbfPolicyRuleEnforceSymmetricReturn
    from GetPbfPolicyRuleFrom
    groupTag string
    name string
    negateDestination boolean
    negateSource boolean
    schedule string
    services string[]
    sourceAddresses string[]
    sourceUsers string[]
    tags string[]
    target GetPbfPolicyRuleTarget
    action GetPbfPolicyRuleAction
    active_active_device_binding str
    Device binding configuration in HA Active-Active mode
    applications Sequence[str]
    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]
    disabled bool
    Disable the rule
    enforce_symmetric_return GetPbfPolicyRuleEnforceSymmetricReturn
    from_ GetPbfPolicyRuleFrom
    group_tag str
    name str
    negate_destination bool
    negate_source bool
    schedule str
    services Sequence[str]
    source_addresses Sequence[str]
    source_users Sequence[str]
    tags Sequence[str]
    target GetPbfPolicyRuleTarget
    action Property Map
    activeActiveDeviceBinding String
    Device binding configuration in HA Active-Active mode
    applications List<String>
    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>
    disabled Boolean
    Disable the rule
    enforceSymmetricReturn Property Map
    from Property Map
    groupTag String
    name String
    negateDestination Boolean
    negateSource Boolean
    schedule String
    services List<String>
    sourceAddresses List<String>
    sourceUsers List<String>
    tags List<String>
    target Property Map

    GetPbfPolicyRuleAction

    discard Property Map
    forward Property Map
    forwardToVsys String
    Virtual system/Shared gateway to route packet to
    noPbf Property Map

    GetPbfPolicyRuleActionForward

    egressInterface String
    Interface to route packet to
    monitor Property Map
    nexthop Property Map

    GetPbfPolicyRuleActionForwardMonitor

    DisableIfUnreachable bool
    Disable this rule if nexthop/monitor ip is unreachable
    IpAddress string
    Monitor IP address
    Profile string
    Monitoring profile associated with this rule
    DisableIfUnreachable bool
    Disable this rule if nexthop/monitor ip is unreachable
    IpAddress string
    Monitor IP address
    Profile string
    Monitoring profile associated with this rule
    disableIfUnreachable Boolean
    Disable this rule if nexthop/monitor ip is unreachable
    ipAddress String
    Monitor IP address
    profile String
    Monitoring profile associated with this rule
    disableIfUnreachable boolean
    Disable this rule if nexthop/monitor ip is unreachable
    ipAddress string
    Monitor IP address
    profile string
    Monitoring profile associated with this rule
    disable_if_unreachable bool
    Disable this rule if nexthop/monitor ip is unreachable
    ip_address str
    Monitor IP address
    profile str
    Monitoring profile associated with this rule
    disableIfUnreachable Boolean
    Disable this rule if nexthop/monitor ip is unreachable
    ipAddress String
    Monitor IP address
    profile String
    Monitoring profile associated with this rule

    GetPbfPolicyRuleActionForwardNexthop

    Fqdn string
    nexthop address FQDN name configuration
    IpAddress string
    Next hop IP address
    Fqdn string
    nexthop address FQDN name configuration
    IpAddress string
    Next hop IP address
    fqdn String
    nexthop address FQDN name configuration
    ipAddress String
    Next hop IP address
    fqdn string
    nexthop address FQDN name configuration
    ipAddress string
    Next hop IP address
    fqdn str
    nexthop address FQDN name configuration
    ip_address str
    Next hop IP address
    fqdn String
    nexthop address FQDN name configuration
    ipAddress String
    Next hop IP address

    GetPbfPolicyRuleEnforceSymmetricReturn

    enabled Boolean
    Enable symmetric return
    nexthopAddressLists List<Property Map>

    GetPbfPolicyRuleEnforceSymmetricReturnNexthopAddressList

    Name string
    Name string
    name String
    name string
    name str
    name String

    GetPbfPolicyRuleFrom

    Interfaces List<string>
    Zones List<string>
    Interfaces []string
    Zones []string
    interfaces List<String>
    zones List<String>
    interfaces string[]
    zones string[]
    interfaces Sequence[str]
    zones Sequence[str]
    interfaces List<String>
    zones List<String>

    GetPbfPolicyRuleTarget

    Devices List<GetPbfPolicyRuleTargetDevice>
    Negate bool
    Target to all but these specified devices and tags
    Tags List<string>
    Devices []GetPbfPolicyRuleTargetDevice
    Negate bool
    Target to all but these specified devices and tags
    Tags []string
    devices List<GetPbfPolicyRuleTargetDevice>
    negate Boolean
    Target to all but these specified devices and tags
    tags List<String>
    devices GetPbfPolicyRuleTargetDevice[]
    negate boolean
    Target to all but these specified devices and tags
    tags string[]
    devices Sequence[GetPbfPolicyRuleTargetDevice]
    negate bool
    Target to all but these specified devices and tags
    tags Sequence[str]
    devices List<Property Map>
    negate Boolean
    Target to all but these specified devices and tags
    tags List<String>

    GetPbfPolicyRuleTargetDevice

    GetPbfPolicyRuleTargetDeviceVsy

    Name string
    Name string
    name String
    name string
    name str
    name String

    Package Details

    Repository
    panos paloaltonetworks/terraform-provider-panos
    License
    Notes
    This Pulumi package is based on the panos Terraform Provider.
    Viewing docs for panos 2.0.11
    published on Tuesday, Apr 28, 2026 by paloaltonetworks
    Schema (JSON)
    paloaltonetworks/terraform-provider-panos
      Try Pulumi Cloud free. Your team will thank you.