getPbfRule

Strata Cloud Manager v1.0.3, Jan 22 26

Strata Cloud Manager v1.0.3 published on Thursday, Jan 22, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

Strata Cloud Manager v1.0.3 published on Thursday, Jan 22, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";

// Define the data source (the item to be retrieved via API GET)
const pbfExternalWebTestGet = scm.getPbfRule({
    id: "044d67ad-1c36-4b97-bbf4-584445fe8a7d",
});
export const retrievedIDAndName = {
    id: pbfExternalWebTestGet.then(pbfExternalWebTestGet => pbfExternalWebTestGet.id),
    name: pbfExternalWebTestGet.then(pbfExternalWebTestGet => pbfExternalWebTestGet.name),
};
export const recievedResponse = pbfExternalWebTestGet;

import pulumi
import pulumi_scm as scm

# Define the data source (the item to be retrieved via API GET)
pbf_external_web_test_get = scm.get_pbf_rule(id="044d67ad-1c36-4b97-bbf4-584445fe8a7d")
pulumi.export("retrievedIDAndName", {
    "id": pbf_external_web_test_get.id,
    "name": pbf_external_web_test_get.name,
})
pulumi.export("recievedResponse", pbf_external_web_test_get)

package main

import (
	"github.com/pulumi/pulumi-scm/sdk/go/scm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Define the data source (the item to be retrieved via API GET)
		pbfExternalWebTestGet, err := scm.LookupPbfRule(ctx, &scm.LookupPbfRuleArgs{
			Id: "044d67ad-1c36-4b97-bbf4-584445fe8a7d",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("retrievedIDAndName", pulumi.StringMap{
			"id":   pbfExternalWebTestGet.Id,
			"name": pbfExternalWebTestGet.Name,
		})
		ctx.Export("recievedResponse", pbfExternalWebTestGet)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;

return await Deployment.RunAsync(() => 
{
    // Define the data source (the item to be retrieved via API GET)
    var pbfExternalWebTestGet = Scm.GetPbfRule.Invoke(new()
    {
        Id = "044d67ad-1c36-4b97-bbf4-584445fe8a7d",
    });

    return new Dictionary<string, object?>
    {
        ["retrievedIDAndName"] = 
        {
            { "id", pbfExternalWebTestGet.Apply(getPbfRuleResult => getPbfRuleResult.Id) },
            { "name", pbfExternalWebTestGet.Apply(getPbfRuleResult => getPbfRuleResult.Name) },
        },
        ["recievedResponse"] = pbfExternalWebTestGet,
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.ScmFunctions;
import com.pulumi.scm.inputs.GetPbfRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Define the data source (the item to be retrieved via API GET)
        final var pbfExternalWebTestGet = ScmFunctions.getPbfRule(GetPbfRuleArgs.builder()
            .id("044d67ad-1c36-4b97-bbf4-584445fe8a7d")
            .build());

        ctx.export("retrievedIDAndName", Map.ofEntries(
            Map.entry("id", pbfExternalWebTestGet.id()),
            Map.entry("name", pbfExternalWebTestGet.name())
        ));
        ctx.export("recievedResponse", pbfExternalWebTestGet);
    }
}

variables:
  # Define the data source (the item to be retrieved via API GET)
  pbfExternalWebTestGet:
    fn::invoke:
      function: scm:getPbfRule
      arguments:
        id: 044d67ad-1c36-4b97-bbf4-584445fe8a7d
outputs:
  # --- Output Blocks to Print Retrieved Data ---
  retrievedIDAndName:
    id: ${pbfExternalWebTestGet.id}
    name: ${pbfExternalWebTestGet.name}
  recievedResponse: ${pbfExternalWebTestGet}

Using getPbfRule

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 getPbfRule(args: GetPbfRuleArgs, opts?: InvokeOptions): Promise<GetPbfRuleResult>
function getPbfRuleOutput(args: GetPbfRuleOutputArgs, opts?: InvokeOptions): Output<GetPbfRuleResult>

def get_pbf_rule(device: Optional[str] = None,
                 folder: Optional[str] = None,
                 id: Optional[str] = None,
                 name: Optional[str] = None,
                 snippet: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetPbfRuleResult
def get_pbf_rule_output(device: Optional[pulumi.Input[str]] = None,
                 folder: Optional[pulumi.Input[str]] = None,
                 id: Optional[pulumi.Input[str]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 snippet: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetPbfRuleResult]

func LookupPbfRule(ctx *Context, args *LookupPbfRuleArgs, opts ...InvokeOption) (*LookupPbfRuleResult, error)
func LookupPbfRuleOutput(ctx *Context, args *LookupPbfRuleOutputArgs, opts ...InvokeOption) LookupPbfRuleResultOutput

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

public static class GetPbfRule 
{
    public static Task<GetPbfRuleResult> InvokeAsync(GetPbfRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetPbfRuleResult> Invoke(GetPbfRuleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPbfRuleResult> getPbfRule(GetPbfRuleArgs args, InvokeOptions options)
public static Output<GetPbfRuleResult> getPbfRule(GetPbfRuleArgs args, InvokeOptions options)

fn::invoke:
  function: scm:index/getPbfRule:getPbfRule
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: UUID of the resource
Device string: The device in which the resource is defined
Folder string
Name string
Snippet string

Id string: UUID of the resource
Device string: The device in which the resource is defined
Folder string
Name string
Snippet string

id String: UUID of the resource
device String: The device in which the resource is defined
folder String
name String
snippet String

id string: UUID of the resource
device string: The device in which the resource is defined
folder string
name string
snippet string

id str: UUID of the resource
device str: The device in which the resource is defined
folder str
name str
snippet str

id String: UUID of the resource
device String: The device in which the resource is defined
folder String
name String
snippet String

getPbfRule Result

The following output properties are available:

Action GetPbfRuleAction
Applications List<string>
Description string
Destinations List<string>
Device string: The device in which the resource is defined
EnforceSymmetricReturn GetPbfRuleEnforceSymmetricReturn
Folder string
From GetPbfRuleFrom
Id string: UUID of the resource
Name string
Schedule string
Services List<string>
Snippet string
SourceUsers List<string>
Sources List<string>
Tags List<string>
Tfid string

Action GetPbfRuleAction
Applications []string
Description string
Destinations []string
Device string: The device in which the resource is defined
EnforceSymmetricReturn GetPbfRuleEnforceSymmetricReturn
Folder string
From GetPbfRuleFrom
Id string: UUID of the resource
Name string
Schedule string
Services []string
Snippet string
SourceUsers []string
Sources []string
Tags []string
Tfid string

action GetPbfRuleAction
applications List<String>
description String
destinations List<String>
device String: The device in which the resource is defined
enforceSymmetricReturn GetPbfRuleEnforceSymmetricReturn
folder String
from GetPbfRuleFrom
id String: UUID of the resource
name String
schedule String
services List<String>
snippet String
sourceUsers List<String>
sources List<String>
tags List<String>
tfid String

action GetPbfRuleAction
applications string[]
description string
destinations string[]
device string: The device in which the resource is defined
enforceSymmetricReturn GetPbfRuleEnforceSymmetricReturn
folder string
from GetPbfRuleFrom
id string: UUID of the resource
name string
schedule string
services string[]
snippet string
sourceUsers string[]
sources string[]
tags string[]
tfid string

action GetPbfRuleAction
applications Sequence[str]
description str
destinations Sequence[str]
device str: The device in which the resource is defined
enforce_symmetric_return GetPbfRuleEnforceSymmetricReturn
folder str
from_ GetPbfRuleFrom
id str: UUID of the resource
name str
schedule str
services Sequence[str]
snippet str
source_users Sequence[str]
sources Sequence[str]
tags Sequence[str]
tfid str

action Property Map
applications List<String>
description String
destinations List<String>
device String: The device in which the resource is defined
enforceSymmetricReturn Property Map
folder String
from Property Map
id String: UUID of the resource
name String
schedule String
services List<String>
snippet String
sourceUsers List<String>
sources List<String>
tags List<String>
tfid String

Supporting Types

GetPbfRuleAction

Discard GetPbfRuleActionDiscard: Discard
Forward GetPbfRuleActionForward: Forward
ℹ️ Note: You must specify exactly one of discard, forward, and no_pbf.
NoPbf GetPbfRuleActionNoPbf: No pbf
ℹ️ Note: You must specify exactly one of discard, forward, and no_pbf.

Discard GetPbfRuleActionDiscard: Discard
Forward GetPbfRuleActionForward: Forward
ℹ️ Note: You must specify exactly one of discard, forward, and no_pbf.
NoPbf GetPbfRuleActionNoPbf: No pbf
ℹ️ Note: You must specify exactly one of discard, forward, and no_pbf.

discard GetPbfRuleActionDiscard: Discard
forward GetPbfRuleActionForward: Forward
ℹ️ Note: You must specify exactly one of discard, forward, and no_pbf.
noPbf GetPbfRuleActionNoPbf: No pbf
ℹ️ Note: You must specify exactly one of discard, forward, and no_pbf.

discard GetPbfRuleActionDiscard: Discard
forward GetPbfRuleActionForward: Forward
ℹ️ Note: You must specify exactly one of discard, forward, and no_pbf.
noPbf GetPbfRuleActionNoPbf: No pbf
ℹ️ Note: You must specify exactly one of discard, forward, and no_pbf.

discard GetPbfRuleActionDiscard: Discard
forward GetPbfRuleActionForward: Forward
ℹ️ Note: You must specify exactly one of discard, forward, and no_pbf.
no_pbf GetPbfRuleActionNoPbf: No pbf
ℹ️ Note: You must specify exactly one of discard, forward, and no_pbf.

discard Property Map: Discard
forward Property Map: Forward
ℹ️ Note: You must specify exactly one of discard, forward, and no_pbf.
noPbf Property Map: No pbf
ℹ️ Note: You must specify exactly one of discard, forward, and no_pbf.

GetPbfRuleActionForward

EgressInterface string: Egress interface
Monitor GetPbfRuleActionForwardMonitor: Monitor
Nexthop GetPbfRuleActionForwardNexthop: Nexthop

EgressInterface string: Egress interface
Monitor GetPbfRuleActionForwardMonitor: Monitor
Nexthop GetPbfRuleActionForwardNexthop: Nexthop

egressInterface String: Egress interface
monitor GetPbfRuleActionForwardMonitor: Monitor
nexthop GetPbfRuleActionForwardNexthop: Nexthop

egressInterface string: Egress interface
monitor GetPbfRuleActionForwardMonitor: Monitor
nexthop GetPbfRuleActionForwardNexthop: Nexthop

egress_interface str: Egress interface
monitor GetPbfRuleActionForwardMonitor: Monitor
nexthop GetPbfRuleActionForwardNexthop: Nexthop

egressInterface String: Egress interface
monitor Property Map: Monitor
nexthop Property Map: Nexthop

GetPbfRuleActionForwardMonitor

DisableIfUnreachable bool: Disable this rule if nexthop/monitor ip is unreachable?
IpAddress string: Monitor IP address
Profile string: Monitoring profile

DisableIfUnreachable bool: Disable this rule if nexthop/monitor ip is unreachable?
IpAddress string: Monitor IP address
Profile string: Monitoring profile

disableIfUnreachable Boolean: Disable this rule if nexthop/monitor ip is unreachable?
ipAddress String: Monitor IP address
profile String: Monitoring profile

disableIfUnreachable boolean: Disable this rule if nexthop/monitor ip is unreachable?
ipAddress string: Monitor IP address
profile string: Monitoring profile

disable_if_unreachable bool: Disable this rule if nexthop/monitor ip is unreachable?
ip_address str: Monitor IP address
profile str: Monitoring profile

disableIfUnreachable Boolean: Disable this rule if nexthop/monitor ip is unreachable?
ipAddress String: Monitor IP address
profile String: Monitoring profile

GetPbfRuleActionForwardNexthop

Fqdn string: Next hop FQDN
IpAddress string: Next hop IP address
ℹ️ Note: You must specify exactly one of fqdn and ip_address.

Fqdn string: Next hop FQDN
IpAddress string: Next hop IP address
ℹ️ Note: You must specify exactly one of fqdn and ip_address.

fqdn String: Next hop FQDN
ipAddress String: Next hop IP address
ℹ️ Note: You must specify exactly one of fqdn and ip_address.

fqdn string: Next hop FQDN
ipAddress string: Next hop IP address
ℹ️ Note: You must specify exactly one of fqdn and ip_address.

fqdn str: Next hop FQDN
ip_address str: Next hop IP address
ℹ️ Note: You must specify exactly one of fqdn and ip_address.

fqdn String: Next hop FQDN
ipAddress String: Next hop IP address
ℹ️ Note: You must specify exactly one of fqdn and ip_address.

GetPbfRuleEnforceSymmetricReturn

Enabled bool: Enforce symmetric return?
NexthopAddressLists List<GetPbfRuleEnforceSymmetricReturnNexthopAddressList>: Next hop IP addresses

Enabled bool: Enforce symmetric return?
NexthopAddressLists []GetPbfRuleEnforceSymmetricReturnNexthopAddressList: Next hop IP addresses

enabled Boolean: Enforce symmetric return?
nexthopAddressLists List<GetPbfRuleEnforceSymmetricReturnNexthopAddressList>: Next hop IP addresses

enabled boolean: Enforce symmetric return?
nexthopAddressLists GetPbfRuleEnforceSymmetricReturnNexthopAddressList[]: Next hop IP addresses

enabled bool: Enforce symmetric return?
nexthop_address_lists Sequence[GetPbfRuleEnforceSymmetricReturnNexthopAddressList]: Next hop IP addresses

enabled Boolean: Enforce symmetric return?
nexthopAddressLists List<Property Map>: Next hop IP addresses

GetPbfRuleEnforceSymmetricReturnNexthopAddressList

Name string: Next hop IP address

Name string: Next hop IP address

name String: Next hop IP address

name string: Next hop IP address

name str: Next hop IP address

name String: Next hop IP address

GetPbfRuleFrom

Interfaces List<string>: Source interfaces
Zones List<string>: Source zones
ℹ️ Note: You must specify exactly one of interface and zone.

Interfaces []string: Source interfaces
Zones []string: Source zones
ℹ️ Note: You must specify exactly one of interface and zone.

interfaces List<String>: Source interfaces
zones List<String>: Source zones
ℹ️ Note: You must specify exactly one of interface and zone.

interfaces string[]: Source interfaces
zones string[]: Source zones
ℹ️ Note: You must specify exactly one of interface and zone.

interfaces Sequence[str]: Source interfaces
zones Sequence[str]: Source zones
ℹ️ Note: You must specify exactly one of interface and zone.

interfaces List<String>: Source interfaces
zones List<String>: Source zones
ℹ️ Note: You must specify exactly one of interface and zone.

Package Details

Repository: scm pulumi/pulumi-scm
License: Apache-2.0
Notes: This Pulumi package is based on the scm Terraform Provider.

Strata Cloud Manager v1.0.3 published on Thursday, Jan 22, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

scm.getPbfRule

On this page

On this page

Example Usage

Using getPbfRule

getPbfRule Result

Supporting Types

GetPbfRuleAction

GetPbfRuleActionForward

GetPbfRuleActionForwardMonitor

GetPbfRuleActionForwardNexthop

GetPbfRuleEnforceSymmetricReturn

GetPbfRuleEnforceSymmetricReturnNexthopAddressList

GetPbfRuleFrom

Package Details

On this page

On this page