Docs Packages
  1. Packages
  2. Fortios
  3. API Docs
  4. router
  5. getPolicy
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.router.getPolicy

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

    Use this data source to get information on an fortios router policy

    Using getPolicy

    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 getPolicy(args: GetPolicyArgs, opts?: InvokeOptions): Promise<GetPolicyResult>
function getPolicyOutput(args: GetPolicyOutputArgs, opts?: InvokeOptions): Output<GetPolicyResult>
    def get_policy(seq_num: Optional[int] = None,
               vdomparam: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetPolicyResult
def get_policy_output(seq_num: Optional[pulumi.Input[int]] = None,
               vdomparam: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetPolicyResult]
    func LookupPolicy(ctx *Context, args *LookupPolicyArgs, opts ...InvokeOption) (*LookupPolicyResult, error)
func LookupPolicyOutput(ctx *Context, args *LookupPolicyOutputArgs, opts ...InvokeOption) LookupPolicyResultOutput

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

    public static class GetPolicy 
{
    public static Task<GetPolicyResult> InvokeAsync(GetPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyResult> Invoke(GetPolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPolicyResult> getPolicy(GetPolicyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: fortios:router/getPolicy:getPolicy
  arguments:
    # arguments dictionary

    The following arguments are supported:

    SeqNum int
    Specify the seq_num of the desired router policy.
    Vdomparam string
    Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    SeqNum int
    Specify the seq_num of the desired router policy.
    Vdomparam string
    Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    seqNum Integer
    Specify the seq_num of the desired router policy.
    vdomparam String
    Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    seqNum number
    Specify the seq_num of the desired router policy.
    vdomparam string
    Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    seq_num int
    Specify the seq_num of the desired router policy.
    vdomparam str
    Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    seqNum Number
    Specify the seq_num of the desired router policy.
    vdomparam String
    Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    getPolicy Result

    The following output properties are available:

    Action string
    Action of the policy route.
    Comments string
    Optional comments.
    DstNegate string
    Enable/disable negating destination address match.
    Dstaddrs List<Pulumiverse.Fortios.Router.Outputs.GetPolicyDstaddr>
    Destination address name. The structure of dstaddr block is documented below.
    Dsts List<Pulumiverse.Fortios.Router.Outputs.GetPolicyDst>
    Destination IP and mask (x.x.x.x/x). The structure of dst block is documented below.
    EndPort int
    End destination port number (0 - 65535).
    EndSourcePort int
    End source port number (0 - 65535).
    Gateway string
    IP address of the gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    InputDeviceNegate string
    Enable/disable negation of input device match.
    InputDevices List<Pulumiverse.Fortios.Router.Outputs.GetPolicyInputDevice>
    Incoming interface name. The structure of input_device block is documented below.
    InternetServiceCustoms List<Pulumiverse.Fortios.Router.Outputs.GetPolicyInternetServiceCustom>
    Custom Destination Internet Service name. The structure of internet_service_custom block is documented below.
    InternetServiceIds List<Pulumiverse.Fortios.Router.Outputs.GetPolicyInternetServiceId>
    Destination Internet Service ID. The structure of internet_service_id block is documented below.
    OutputDevice string
    Outgoing interface name.
    Protocol int
    Protocol number (0 - 255).
    SeqNum int
    Sequence number.
    SrcNegate string
    Enable/disable negating source address match.
    Srcaddrs List<Pulumiverse.Fortios.Router.Outputs.GetPolicySrcaddr>
    Source address name. The structure of srcaddr block is documented below.
    Srcs List<Pulumiverse.Fortios.Router.Outputs.GetPolicySrc>
    Source IP and mask (x.x.x.x/x). The structure of src block is documented below.
    StartPort int
    Start destination port number (0 - 65535).
    StartSourcePort int
    Start source port number (0 - 65535).
    Status string
    Enable/disable this policy route.
    Tos string
    Type of service bit pattern.
    TosMask string
    Type of service evaluated bits.
    Vdomparam string
    Action string
    Action of the policy route.
    Comments string
    Optional comments.
    DstNegate string
    Enable/disable negating destination address match.
    Dstaddrs []GetPolicyDstaddr
    Destination address name. The structure of dstaddr block is documented below.
    Dsts []GetPolicyDst
    Destination IP and mask (x.x.x.x/x). The structure of dst block is documented below.
    EndPort int
    End destination port number (0 - 65535).
    EndSourcePort int
    End source port number (0 - 65535).
    Gateway string
    IP address of the gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    InputDeviceNegate string
    Enable/disable negation of input device match.
    InputDevices []GetPolicyInputDevice
    Incoming interface name. The structure of input_device block is documented below.
    InternetServiceCustoms []GetPolicyInternetServiceCustom
    Custom Destination Internet Service name. The structure of internet_service_custom block is documented below.
    InternetServiceIds []GetPolicyInternetServiceId
    Destination Internet Service ID. The structure of internet_service_id block is documented below.
    OutputDevice string
    Outgoing interface name.
    Protocol int
    Protocol number (0 - 255).
    SeqNum int
    Sequence number.
    SrcNegate string
    Enable/disable negating source address match.
    Srcaddrs []GetPolicySrcaddr
    Source address name. The structure of srcaddr block is documented below.
    Srcs []GetPolicySrc
    Source IP and mask (x.x.x.x/x). The structure of src block is documented below.
    StartPort int
    Start destination port number (0 - 65535).
    StartSourcePort int
    Start source port number (0 - 65535).
    Status string
    Enable/disable this policy route.
    Tos string
    Type of service bit pattern.
    TosMask string
    Type of service evaluated bits.
    Vdomparam string
    action String
    Action of the policy route.
    comments String
    Optional comments.
    dstNegate String
    Enable/disable negating destination address match.
    dstaddrs List<GetPolicyDstaddr>
    Destination address name. The structure of dstaddr block is documented below.
    dsts List<GetPolicyDst>
    Destination IP and mask (x.x.x.x/x). The structure of dst block is documented below.
    endPort Integer
    End destination port number (0 - 65535).
    endSourcePort Integer
    End source port number (0 - 65535).
    gateway String
    IP address of the gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    inputDeviceNegate String
    Enable/disable negation of input device match.
    inputDevices List<GetPolicyInputDevice>
    Incoming interface name. The structure of input_device block is documented below.
    internetServiceCustoms List<GetPolicyInternetServiceCustom>
    Custom Destination Internet Service name. The structure of internet_service_custom block is documented below.
    internetServiceIds List<GetPolicyInternetServiceId>
    Destination Internet Service ID. The structure of internet_service_id block is documented below.
    outputDevice String
    Outgoing interface name.
    protocol Integer
    Protocol number (0 - 255).
    seqNum Integer
    Sequence number.
    srcNegate String
    Enable/disable negating source address match.
    srcaddrs List<GetPolicySrcaddr>
    Source address name. The structure of srcaddr block is documented below.
    srcs List<GetPolicySrc>
    Source IP and mask (x.x.x.x/x). The structure of src block is documented below.
    startPort Integer
    Start destination port number (0 - 65535).
    startSourcePort Integer
    Start source port number (0 - 65535).
    status String
    Enable/disable this policy route.
    tos String
    Type of service bit pattern.
    tosMask String
    Type of service evaluated bits.
    vdomparam String
    action string
    Action of the policy route.
    comments string
    Optional comments.
    dstNegate string
    Enable/disable negating destination address match.
    dstaddrs GetPolicyDstaddr[]
    Destination address name. The structure of dstaddr block is documented below.
    dsts GetPolicyDst[]
    Destination IP and mask (x.x.x.x/x). The structure of dst block is documented below.
    endPort number
    End destination port number (0 - 65535).
    endSourcePort number
    End source port number (0 - 65535).
    gateway string
    IP address of the gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    inputDeviceNegate string
    Enable/disable negation of input device match.
    inputDevices GetPolicyInputDevice[]
    Incoming interface name. The structure of input_device block is documented below.
    internetServiceCustoms GetPolicyInternetServiceCustom[]
    Custom Destination Internet Service name. The structure of internet_service_custom block is documented below.
    internetServiceIds GetPolicyInternetServiceId[]
    Destination Internet Service ID. The structure of internet_service_id block is documented below.
    outputDevice string
    Outgoing interface name.
    protocol number
    Protocol number (0 - 255).
    seqNum number
    Sequence number.
    srcNegate string
    Enable/disable negating source address match.
    srcaddrs GetPolicySrcaddr[]
    Source address name. The structure of srcaddr block is documented below.
    srcs GetPolicySrc[]
    Source IP and mask (x.x.x.x/x). The structure of src block is documented below.
    startPort number
    Start destination port number (0 - 65535).
    startSourcePort number
    Start source port number (0 - 65535).
    status string
    Enable/disable this policy route.
    tos string
    Type of service bit pattern.
    tosMask string
    Type of service evaluated bits.
    vdomparam string
    action str
    Action of the policy route.
    comments str
    Optional comments.
    dst_negate str
    Enable/disable negating destination address match.
    dstaddrs Sequence[GetPolicyDstaddr]
    Destination address name. The structure of dstaddr block is documented below.
    dsts Sequence[GetPolicyDst]
    Destination IP and mask (x.x.x.x/x). The structure of dst block is documented below.
    end_port int
    End destination port number (0 - 65535).
    end_source_port int
    End source port number (0 - 65535).
    gateway str
    IP address of the gateway.
    id str
    The provider-assigned unique ID for this managed resource.
    input_device_negate str
    Enable/disable negation of input device match.
    input_devices Sequence[GetPolicyInputDevice]
    Incoming interface name. The structure of input_device block is documented below.
    internet_service_customs Sequence[GetPolicyInternetServiceCustom]
    Custom Destination Internet Service name. The structure of internet_service_custom block is documented below.
    internet_service_ids Sequence[GetPolicyInternetServiceId]
    Destination Internet Service ID. The structure of internet_service_id block is documented below.
    output_device str
    Outgoing interface name.
    protocol int
    Protocol number (0 - 255).
    seq_num int
    Sequence number.
    src_negate str
    Enable/disable negating source address match.
    srcaddrs Sequence[GetPolicySrcaddr]
    Source address name. The structure of srcaddr block is documented below.
    srcs Sequence[GetPolicySrc]
    Source IP and mask (x.x.x.x/x). The structure of src block is documented below.
    start_port int
    Start destination port number (0 - 65535).
    start_source_port int
    Start source port number (0 - 65535).
    status str
    Enable/disable this policy route.
    tos str
    Type of service bit pattern.
    tos_mask str
    Type of service evaluated bits.
    vdomparam str
    action String
    Action of the policy route.
    comments String
    Optional comments.
    dstNegate String
    Enable/disable negating destination address match.
    dstaddrs List<Property Map>
    Destination address name. The structure of dstaddr block is documented below.
    dsts List<Property Map>
    Destination IP and mask (x.x.x.x/x). The structure of dst block is documented below.
    endPort Number
    End destination port number (0 - 65535).
    endSourcePort Number
    End source port number (0 - 65535).
    gateway String
    IP address of the gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    inputDeviceNegate String
    Enable/disable negation of input device match.
    inputDevices List<Property Map>
    Incoming interface name. The structure of input_device block is documented below.
    internetServiceCustoms List<Property Map>
    Custom Destination Internet Service name. The structure of internet_service_custom block is documented below.
    internetServiceIds List<Property Map>
    Destination Internet Service ID. The structure of internet_service_id block is documented below.
    outputDevice String
    Outgoing interface name.
    protocol Number
    Protocol number (0 - 255).
    seqNum Number
    Sequence number.
    srcNegate String
    Enable/disable negating source address match.
    srcaddrs List<Property Map>
    Source address name. The structure of srcaddr block is documented below.
    srcs List<Property Map>
    Source IP and mask (x.x.x.x/x). The structure of src block is documented below.
    startPort Number
    Start destination port number (0 - 65535).
    startSourcePort Number
    Start source port number (0 - 65535).
    status String
    Enable/disable this policy route.
    tos String
    Type of service bit pattern.
    tosMask String
    Type of service evaluated bits.
    vdomparam String

    Supporting Types

    GetPolicyDst

    Subnet string
    IP and mask.
    Subnet string
    IP and mask.
    subnet String
    IP and mask.
    subnet string
    IP and mask.
    subnet str
    IP and mask.
    subnet String
    IP and mask.

    GetPolicyDstaddr

    Name string
    Custom Destination Internet Service name.
    Name string
    Custom Destination Internet Service name.
    name String
    Custom Destination Internet Service name.
    name string
    Custom Destination Internet Service name.
    name str
    Custom Destination Internet Service name.
    name String
    Custom Destination Internet Service name.

    GetPolicyInputDevice

    Name string
    Custom Destination Internet Service name.
    Name string
    Custom Destination Internet Service name.
    name String
    Custom Destination Internet Service name.
    name string
    Custom Destination Internet Service name.
    name str
    Custom Destination Internet Service name.
    name String
    Custom Destination Internet Service name.

    GetPolicyInternetServiceCustom

    Name string
    Custom Destination Internet Service name.
    Name string
    Custom Destination Internet Service name.
    name String
    Custom Destination Internet Service name.
    name string
    Custom Destination Internet Service name.
    name str
    Custom Destination Internet Service name.
    name String
    Custom Destination Internet Service name.

    GetPolicyInternetServiceId

    Id int
    Destination Internet Service ID.
    Id int
    Destination Internet Service ID.
    id Integer
    Destination Internet Service ID.
    id number
    Destination Internet Service ID.
    id int
    Destination Internet Service ID.
    id Number
    Destination Internet Service ID.

    GetPolicySrc

    Subnet string
    IP and mask.
    Subnet string
    IP and mask.
    subnet String
    IP and mask.
    subnet string
    IP and mask.
    subnet str
    IP and mask.
    subnet String
    IP and mask.

    GetPolicySrcaddr

    Name string
    Custom Destination Internet Service name.
    Name string
    Custom Destination Internet Service name.
    name String
    Custom Destination Internet Service name.
    name string
    Custom Destination Internet Service name.
    name str
    Custom Destination Internet Service name.
    name String
    Custom Destination Internet Service name.

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios