1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. getPbfRuleList
Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-scm

scm.getPbfRuleList

scm logo
Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-scm

    Retrieves a listing of config items.

    Example Usage

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

// Define a data source for listing pbf rules
const pagedPbfRulesList = scm.getPbfRuleList({
    folder: "All",
    limit: 10,
});
export const fetchedPbfRuleListSummary = {
    totalRulesInList: pagedPbfRulesList.then(pagedPbfRulesList => pagedPbfRulesList.total),
    allRules: pagedPbfRulesList.then(pagedPbfRulesList => pagedPbfRulesList.datas),
};

    import pulumi
import pulumi_scm as scm

# Define a data source for listing pbf rules
paged_pbf_rules_list = scm.get_pbf_rule_list(folder="All",
    limit=10)
pulumi.export("fetchedPbfRuleListSummary", {
    "totalRulesInList": paged_pbf_rules_list.total,
    "allRules": paged_pbf_rules_list.datas,
})

    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 a data source for listing pbf rules
		pagedPbfRulesList, err := scm.GetPbfRuleList(ctx, &scm.GetPbfRuleListArgs{
			Folder: pulumi.StringRef("All"),
			Limit:  pulumi.IntRef(10),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("fetchedPbfRuleListSummary", pulumi.Map{
			"totalRulesInList": pagedPbfRulesList.Total,
			"allRules":         pagedPbfRulesList.Datas,
		})
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Define a data source for listing pbf rules
    var pagedPbfRulesList = Scm.GetPbfRuleList.Invoke(new()
    {
        Folder = "All",
        Limit = 10,
    });

    return new Dictionary<string, object?>
    {
        ["fetchedPbfRuleListSummary"] = 
        {
            { "totalRulesInList", pagedPbfRulesList.Apply(getPbfRuleListResult => getPbfRuleListResult.Total) },
            { "allRules", pagedPbfRulesList.Apply(getPbfRuleListResult => getPbfRuleListResult.Datas) },
        },
    };
});

    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.GetPbfRuleListArgs;
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 a data source for listing pbf rules
        final var pagedPbfRulesList = ScmFunctions.getPbfRuleList(GetPbfRuleListArgs.builder()
            .folder("All")
            .limit(10)
            .build());

        ctx.export("fetchedPbfRuleListSummary", Map.ofEntries(
            Map.entry("totalRulesInList", pagedPbfRulesList.total()),
            Map.entry("allRules", pagedPbfRulesList.datas())
        ));
    }
}

    variables:
  # Define a data source for listing pbf rules
  pagedPbfRulesList:
    fn::invoke:
      function: scm:getPbfRuleList
      arguments:
        folder: All
        limit: 10
outputs:
  # --- Output Block to Print Retrieved Data ---
  fetchedPbfRuleListSummary:
    totalRulesInList: ${pagedPbfRulesList.total}
    allRules: ${pagedPbfRulesList.datas}

    Using getPbfRuleList

    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 getPbfRuleList(args: GetPbfRuleListArgs, opts?: InvokeOptions): Promise<GetPbfRuleListResult>
function getPbfRuleListOutput(args: GetPbfRuleListOutputArgs, opts?: InvokeOptions): Output<GetPbfRuleListResult>
    def get_pbf_rule_list(device: Optional[str] = None,
                      folder: Optional[str] = None,
                      limit: Optional[int] = None,
                      name: Optional[str] = None,
                      offset: Optional[int] = None,
                      snippet: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetPbfRuleListResult
def get_pbf_rule_list_output(device: Optional[pulumi.Input[str]] = None,
                      folder: Optional[pulumi.Input[str]] = None,
                      limit: Optional[pulumi.Input[int]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      offset: Optional[pulumi.Input[int]] = None,
                      snippet: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetPbfRuleListResult]
    func GetPbfRuleList(ctx *Context, args *GetPbfRuleListArgs, opts ...InvokeOption) (*GetPbfRuleListResult, error)
func GetPbfRuleListOutput(ctx *Context, args *GetPbfRuleListOutputArgs, opts ...InvokeOption) GetPbfRuleListResultOutput

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

    public static class GetPbfRuleList 
{
    public static Task<GetPbfRuleListResult> InvokeAsync(GetPbfRuleListArgs args, InvokeOptions? opts = null)
    public static Output<GetPbfRuleListResult> Invoke(GetPbfRuleListInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPbfRuleListResult> getPbfRuleList(GetPbfRuleListArgs args, InvokeOptions options)
public static Output<GetPbfRuleListResult> getPbfRuleList(GetPbfRuleListArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Device string
    The device of the item.
    Folder string
    The folder of the item. Default: Shared.
    Limit int
    The max number of items to return. Default: 200.
    Name string
    The name of the item.
    Offset int
    The offset of the first item to return.
    Snippet string
    The snippet of the item.
    Device string
    The device of the item.
    Folder string
    The folder of the item. Default: Shared.
    Limit int
    The max number of items to return. Default: 200.
    Name string
    The name of the item.
    Offset int
    The offset of the first item to return.
    Snippet string
    The snippet of the item.
    device String
    The device of the item.
    folder String
    The folder of the item. Default: Shared.
    limit Integer
    The max number of items to return. Default: 200.
    name String
    The name of the item.
    offset Integer
    The offset of the first item to return.
    snippet String
    The snippet of the item.
    device string
    The device of the item.
    folder string
    The folder of the item. Default: Shared.
    limit number
    The max number of items to return. Default: 200.
    name string
    The name of the item.
    offset number
    The offset of the first item to return.
    snippet string
    The snippet of the item.
    device str
    The device of the item.
    folder str
    The folder of the item. Default: Shared.
    limit int
    The max number of items to return. Default: 200.
    name str
    The name of the item.
    offset int
    The offset of the first item to return.
    snippet str
    The snippet of the item.
    device String
    The device of the item.
    folder String
    The folder of the item. Default: Shared.
    limit Number
    The max number of items to return. Default: 200.
    name String
    The name of the item.
    offset Number
    The offset of the first item to return.
    snippet String
    The snippet of the item.

    getPbfRuleList Result

    The following output properties are available:

    Datas List<GetPbfRuleListData>
    The data.
    Id string
    The provider-assigned unique ID for this managed resource.
    Tfid string
    Total int
    The total number of items.
    Device string
    The device of the item.
    Folder string
    The folder of the item. Default: Shared.
    Limit int
    The max number of items to return. Default: 200.
    Name string
    The name of the item.
    Offset int
    The offset of the first item to return.
    Snippet string
    The snippet of the item.
    Datas []GetPbfRuleListData
    The data.
    Id string
    The provider-assigned unique ID for this managed resource.
    Tfid string
    Total int
    The total number of items.
    Device string
    The device of the item.
    Folder string
    The folder of the item. Default: Shared.
    Limit int
    The max number of items to return. Default: 200.
    Name string
    The name of the item.
    Offset int
    The offset of the first item to return.
    Snippet string
    The snippet of the item.
    datas List<GetPbfRuleListData>
    The data.
    id String
    The provider-assigned unique ID for this managed resource.
    tfid String
    total Integer
    The total number of items.
    device String
    The device of the item.
    folder String
    The folder of the item. Default: Shared.
    limit Integer
    The max number of items to return. Default: 200.
    name String
    The name of the item.
    offset Integer
    The offset of the first item to return.
    snippet String
    The snippet of the item.
    datas GetPbfRuleListData[]
    The data.
    id string
    The provider-assigned unique ID for this managed resource.
    tfid string
    total number
    The total number of items.
    device string
    The device of the item.
    folder string
    The folder of the item. Default: Shared.
    limit number
    The max number of items to return. Default: 200.
    name string
    The name of the item.
    offset number
    The offset of the first item to return.
    snippet string
    The snippet of the item.
    datas Sequence[GetPbfRuleListData]
    The data.
    id str
    The provider-assigned unique ID for this managed resource.
    tfid str
    total int
    The total number of items.
    device str
    The device of the item.
    folder str
    The folder of the item. Default: Shared.
    limit int
    The max number of items to return. Default: 200.
    name str
    The name of the item.
    offset int
    The offset of the first item to return.
    snippet str
    The snippet of the item.
    datas List<Property Map>
    The data.
    id String
    The provider-assigned unique ID for this managed resource.
    tfid String
    total Number
    The total number of items.
    device String
    The device of the item.
    folder String
    The folder of the item. Default: Shared.
    limit Number
    The max number of items to return. Default: 200.
    name String
    The name of the item.
    offset Number
    The offset of the first item to return.
    snippet String
    The snippet of the item.

    Supporting Types

    GetPbfRuleListData

    Action GetPbfRuleListDataAction
    Action
    Applications List<string>
    Applications
    Description string
    Description
    Destinations List<string>
    Destination addresses
    Device string
    The device in which the resource is defined
    EnforceSymmetricReturn GetPbfRuleListDataEnforceSymmetricReturn
    Enforce symmetric return
    Folder string
    The folder in which the resource is defined
    From GetPbfRuleListDataFrom
    From
    Id string
    UUID of the resource
    Name string
    PBF rule name
    Schedule string
    Schedule
    Services List<string>
    Services
    Snippet string
    The snippet in which the resource is defined
    SourceUsers List<string>
    Source users
    Sources List<string>
    Source addresses
    Tags List<string>
    Tags
    Tfid string
    Action GetPbfRuleListDataAction
    Action
    Applications []string
    Applications
    Description string
    Description
    Destinations []string
    Destination addresses
    Device string
    The device in which the resource is defined
    EnforceSymmetricReturn GetPbfRuleListDataEnforceSymmetricReturn
    Enforce symmetric return
    Folder string
    The folder in which the resource is defined
    From GetPbfRuleListDataFrom
    From
    Id string
    UUID of the resource
    Name string
    PBF rule name
    Schedule string
    Schedule
    Services []string
    Services
    Snippet string
    The snippet in which the resource is defined
    SourceUsers []string
    Source users
    Sources []string
    Source addresses
    Tags []string
    Tags
    Tfid string
    action GetPbfRuleListDataAction
    Action
    applications List<String>
    Applications
    description String
    Description
    destinations List<String>
    Destination addresses
    device String
    The device in which the resource is defined
    enforceSymmetricReturn GetPbfRuleListDataEnforceSymmetricReturn
    Enforce symmetric return
    folder String
    The folder in which the resource is defined
    from GetPbfRuleListDataFrom
    From
    id String
    UUID of the resource
    name String
    PBF rule name
    schedule String
    Schedule
    services List<String>
    Services
    snippet String
    The snippet in which the resource is defined
    sourceUsers List<String>
    Source users
    sources List<String>
    Source addresses
    tags List<String>
    Tags
    tfid String
    action GetPbfRuleListDataAction
    Action
    applications string[]
    Applications
    description string
    Description
    destinations string[]
    Destination addresses
    device string
    The device in which the resource is defined
    enforceSymmetricReturn GetPbfRuleListDataEnforceSymmetricReturn
    Enforce symmetric return
    folder string
    The folder in which the resource is defined
    from GetPbfRuleListDataFrom
    From
    id string
    UUID of the resource
    name string
    PBF rule name
    schedule string
    Schedule
    services string[]
    Services
    snippet string
    The snippet in which the resource is defined
    sourceUsers string[]
    Source users
    sources string[]
    Source addresses
    tags string[]
    Tags
    tfid string
    action GetPbfRuleListDataAction
    Action
    applications Sequence[str]
    Applications
    description str
    Description
    destinations Sequence[str]
    Destination addresses
    device str
    The device in which the resource is defined
    enforce_symmetric_return GetPbfRuleListDataEnforceSymmetricReturn
    Enforce symmetric return
    folder str
    The folder in which the resource is defined
    from_ GetPbfRuleListDataFrom
    From
    id str
    UUID of the resource
    name str
    PBF rule name
    schedule str
    Schedule
    services Sequence[str]
    Services
    snippet str
    The snippet in which the resource is defined
    source_users Sequence[str]
    Source users
    sources Sequence[str]
    Source addresses
    tags Sequence[str]
    Tags
    tfid str
    action Property Map
    Action
    applications List<String>
    Applications
    description String
    Description
    destinations List<String>
    Destination addresses
    device String
    The device in which the resource is defined
    enforceSymmetricReturn Property Map
    Enforce symmetric return
    folder String
    The folder in which the resource is defined
    from Property Map
    From
    id String
    UUID of the resource
    name String
    PBF rule name
    schedule String
    Schedule
    services List<String>
    Services
    snippet String
    The snippet in which the resource is defined
    sourceUsers List<String>
    Source users
    sources List<String>
    Source addresses
    tags List<String>
    Tags
    tfid String

    GetPbfRuleListDataAction

    GetPbfRuleListDataActionForward

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

    GetPbfRuleListDataActionForwardMonitor

    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

    GetPbfRuleListDataActionForwardNexthop

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

    GetPbfRuleListDataEnforceSymmetricReturn

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

    GetPbfRuleListDataEnforceSymmetricReturnNexthopAddressList

    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

    GetPbfRuleListDataFrom

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

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-scm
      Meet Neo: Your AI Platform Teammate