fortimanager.PackagesAuthenticationRule
Explore with Pulumi AI
Configure Authentication Rules.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as fortimanager from "@pulumi/fortimanager";
const labelname = new fortimanager.PackagesAuthenticationRule("labelname", {
    ipBased: "enable",
    pkg: "default",
    protocol: "http",
    srcaddrs: ["all"],
    status: "enable",
});
import pulumi
import pulumi_fortimanager as fortimanager
labelname = fortimanager.PackagesAuthenticationRule("labelname",
    ip_based="enable",
    pkg="default",
    protocol="http",
    srcaddrs=["all"],
    status="enable")
package main
import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fortimanager/fortimanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fortimanager.NewPackagesAuthenticationRule(ctx, "labelname", &fortimanager.PackagesAuthenticationRuleArgs{
			IpBased:  pulumi.String("enable"),
			Pkg:      pulumi.String("default"),
			Protocol: pulumi.String("http"),
			Srcaddrs: pulumi.StringArray{
				pulumi.String("all"),
			},
			Status: pulumi.String("enable"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortimanager = Pulumi.Fortimanager;
return await Deployment.RunAsync(() => 
{
    var labelname = new Fortimanager.PackagesAuthenticationRule("labelname", new()
    {
        IpBased = "enable",
        Pkg = "default",
        Protocol = "http",
        Srcaddrs = new[]
        {
            "all",
        },
        Status = "enable",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.PackagesAuthenticationRule;
import com.pulumi.fortimanager.PackagesAuthenticationRuleArgs;
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) {
        var labelname = new PackagesAuthenticationRule("labelname", PackagesAuthenticationRuleArgs.builder()
            .ipBased("enable")
            .pkg("default")
            .protocol("http")
            .srcaddrs("all")
            .status("enable")
            .build());
    }
}
resources:
  labelname:
    type: fortimanager:PackagesAuthenticationRule
    properties:
      ipBased: enable
      pkg: default
      protocol: http
      srcaddrs:
        - all
      status: enable
Create PackagesAuthenticationRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PackagesAuthenticationRule(name: string, args: PackagesAuthenticationRuleArgs, opts?: CustomResourceOptions);@overload
def PackagesAuthenticationRule(resource_name: str,
                               args: PackagesAuthenticationRuleArgs,
                               opts: Optional[ResourceOptions] = None)
@overload
def PackagesAuthenticationRule(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               pkg: Optional[str] = None,
                               packages_authentication_rule_id: Optional[str] = None,
                               comments: Optional[str] = None,
                               pkg_folder_path: Optional[str] = None,
                               cors_depth: Optional[float] = None,
                               cors_stateful: Optional[str] = None,
                               dstaddr6s: Optional[Sequence[str]] = None,
                               dstaddrs: Optional[Sequence[str]] = None,
                               ip_based: Optional[str] = None,
                               protocol: Optional[str] = None,
                               active_auth_method: Optional[str] = None,
                               web_portal: Optional[str] = None,
                               cert_auth_cookie: Optional[str] = None,
                               name: Optional[str] = None,
                               scopetype: Optional[str] = None,
                               srcaddr6s: Optional[Sequence[str]] = None,
                               srcaddrs: Optional[Sequence[str]] = None,
                               srcintfs: Optional[Sequence[str]] = None,
                               sso_auth_method: Optional[str] = None,
                               status: Optional[str] = None,
                               transaction_based: Optional[str] = None,
                               web_auth_cookie: Optional[str] = None,
                               adom: Optional[str] = None)func NewPackagesAuthenticationRule(ctx *Context, name string, args PackagesAuthenticationRuleArgs, opts ...ResourceOption) (*PackagesAuthenticationRule, error)public PackagesAuthenticationRule(string name, PackagesAuthenticationRuleArgs args, CustomResourceOptions? opts = null)
public PackagesAuthenticationRule(String name, PackagesAuthenticationRuleArgs args)
public PackagesAuthenticationRule(String name, PackagesAuthenticationRuleArgs args, CustomResourceOptions options)
type: fortimanager:PackagesAuthenticationRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args PackagesAuthenticationRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PackagesAuthenticationRuleArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PackagesAuthenticationRuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PackagesAuthenticationRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PackagesAuthenticationRuleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var packagesAuthenticationRuleResource = new Fortimanager.PackagesAuthenticationRule("packagesAuthenticationRuleResource", new()
{
    Pkg = "string",
    PackagesAuthenticationRuleId = "string",
    Comments = "string",
    PkgFolderPath = "string",
    CorsDepth = 0,
    CorsStateful = "string",
    Dstaddr6s = new[]
    {
        "string",
    },
    Dstaddrs = new[]
    {
        "string",
    },
    IpBased = "string",
    Protocol = "string",
    ActiveAuthMethod = "string",
    WebPortal = "string",
    CertAuthCookie = "string",
    Name = "string",
    Scopetype = "string",
    Srcaddr6s = new[]
    {
        "string",
    },
    Srcaddrs = new[]
    {
        "string",
    },
    Srcintfs = new[]
    {
        "string",
    },
    SsoAuthMethod = "string",
    Status = "string",
    TransactionBased = "string",
    WebAuthCookie = "string",
    Adom = "string",
});
example, err := fortimanager.NewPackagesAuthenticationRule(ctx, "packagesAuthenticationRuleResource", &fortimanager.PackagesAuthenticationRuleArgs{
Pkg: pulumi.String("string"),
PackagesAuthenticationRuleId: pulumi.String("string"),
Comments: pulumi.String("string"),
PkgFolderPath: pulumi.String("string"),
CorsDepth: pulumi.Float64(0),
CorsStateful: pulumi.String("string"),
Dstaddr6s: pulumi.StringArray{
pulumi.String("string"),
},
Dstaddrs: pulumi.StringArray{
pulumi.String("string"),
},
IpBased: pulumi.String("string"),
Protocol: pulumi.String("string"),
ActiveAuthMethod: pulumi.String("string"),
WebPortal: pulumi.String("string"),
CertAuthCookie: pulumi.String("string"),
Name: pulumi.String("string"),
Scopetype: pulumi.String("string"),
Srcaddr6s: pulumi.StringArray{
pulumi.String("string"),
},
Srcaddrs: pulumi.StringArray{
pulumi.String("string"),
},
Srcintfs: pulumi.StringArray{
pulumi.String("string"),
},
SsoAuthMethod: pulumi.String("string"),
Status: pulumi.String("string"),
TransactionBased: pulumi.String("string"),
WebAuthCookie: pulumi.String("string"),
Adom: pulumi.String("string"),
})
var packagesAuthenticationRuleResource = new PackagesAuthenticationRule("packagesAuthenticationRuleResource", PackagesAuthenticationRuleArgs.builder()
    .pkg("string")
    .packagesAuthenticationRuleId("string")
    .comments("string")
    .pkgFolderPath("string")
    .corsDepth(0)
    .corsStateful("string")
    .dstaddr6s("string")
    .dstaddrs("string")
    .ipBased("string")
    .protocol("string")
    .activeAuthMethod("string")
    .webPortal("string")
    .certAuthCookie("string")
    .name("string")
    .scopetype("string")
    .srcaddr6s("string")
    .srcaddrs("string")
    .srcintfs("string")
    .ssoAuthMethod("string")
    .status("string")
    .transactionBased("string")
    .webAuthCookie("string")
    .adom("string")
    .build());
packages_authentication_rule_resource = fortimanager.PackagesAuthenticationRule("packagesAuthenticationRuleResource",
    pkg="string",
    packages_authentication_rule_id="string",
    comments="string",
    pkg_folder_path="string",
    cors_depth=0,
    cors_stateful="string",
    dstaddr6s=["string"],
    dstaddrs=["string"],
    ip_based="string",
    protocol="string",
    active_auth_method="string",
    web_portal="string",
    cert_auth_cookie="string",
    name="string",
    scopetype="string",
    srcaddr6s=["string"],
    srcaddrs=["string"],
    srcintfs=["string"],
    sso_auth_method="string",
    status="string",
    transaction_based="string",
    web_auth_cookie="string",
    adom="string")
const packagesAuthenticationRuleResource = new fortimanager.PackagesAuthenticationRule("packagesAuthenticationRuleResource", {
    pkg: "string",
    packagesAuthenticationRuleId: "string",
    comments: "string",
    pkgFolderPath: "string",
    corsDepth: 0,
    corsStateful: "string",
    dstaddr6s: ["string"],
    dstaddrs: ["string"],
    ipBased: "string",
    protocol: "string",
    activeAuthMethod: "string",
    webPortal: "string",
    certAuthCookie: "string",
    name: "string",
    scopetype: "string",
    srcaddr6s: ["string"],
    srcaddrs: ["string"],
    srcintfs: ["string"],
    ssoAuthMethod: "string",
    status: "string",
    transactionBased: "string",
    webAuthCookie: "string",
    adom: "string",
});
type: fortimanager:PackagesAuthenticationRule
properties:
    activeAuthMethod: string
    adom: string
    certAuthCookie: string
    comments: string
    corsDepth: 0
    corsStateful: string
    dstaddr6s:
        - string
    dstaddrs:
        - string
    ipBased: string
    name: string
    packagesAuthenticationRuleId: string
    pkg: string
    pkgFolderPath: string
    protocol: string
    scopetype: string
    srcaddr6s:
        - string
    srcaddrs:
        - string
    srcintfs:
        - string
    ssoAuthMethod: string
    status: string
    transactionBased: string
    webAuthCookie: string
    webPortal: string
PackagesAuthenticationRule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PackagesAuthenticationRule resource accepts the following input properties:
- Pkg string
- Package.
- ActiveAuth stringMethod 
- Select an active authentication method.
- Adom string
- Adom. This value is valid only when the scopetypeisadom, otherwise the value of adom in the provider will be inherited.
- string
- Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable,enable.
- Comments string
- Comment.
- CorsDepth double
- Depth to allow CORS access (default = 3).
- CorsStateful string
- Enable/disable allowance of CORS access (default = disable). Valid values: disable,enable.
- Dstaddr6s List<string>
- Select an IPv6 destination address from available options. Required for web proxy authentication.
- Dstaddrs List<string>
- Select an IPv4 destination address from available options. Required for web proxy authentication.
- IpBased string
- Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable,enable.
- Name string
- Authentication rule name.
- PackagesAuthentication stringRule Id 
- an identifier for the resource with format {{name}}.
- PkgFolder stringPath 
- Pkg Folder Path.
- Protocol string
- Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http,ftp,socks,ssh.
- Scopetype string
- The scope of application of the resource. Valid values: inherit,adom. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit.
- Srcaddr6s List<string>
- Select an IPv6 source address. Required for web proxy authentication.
- Srcaddrs List<string>
- Select an IPv4 source address from available options. Required for web proxy authentication.
- Srcintfs List<string>
- Incoming (ingress) interface.
- SsoAuth stringMethod 
- Select a single-sign on (SSO) authentication method.
- Status string
- Enable/disable this authentication rule. Valid values: disable,enable.
- TransactionBased string
- Enable/disable transaction based authentication (default = disable). Valid values: disable,enable.
- string
- Enable/disable Web authentication cookies (default = disable). Valid values: disable,enable.
- WebPortal string
- Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable,enable.
- Pkg string
- Package.
- ActiveAuth stringMethod 
- Select an active authentication method.
- Adom string
- Adom. This value is valid only when the scopetypeisadom, otherwise the value of adom in the provider will be inherited.
- string
- Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable,enable.
- Comments string
- Comment.
- CorsDepth float64
- Depth to allow CORS access (default = 3).
- CorsStateful string
- Enable/disable allowance of CORS access (default = disable). Valid values: disable,enable.
- Dstaddr6s []string
- Select an IPv6 destination address from available options. Required for web proxy authentication.
- Dstaddrs []string
- Select an IPv4 destination address from available options. Required for web proxy authentication.
- IpBased string
- Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable,enable.
- Name string
- Authentication rule name.
- PackagesAuthentication stringRule Id 
- an identifier for the resource with format {{name}}.
- PkgFolder stringPath 
- Pkg Folder Path.
- Protocol string
- Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http,ftp,socks,ssh.
- Scopetype string
- The scope of application of the resource. Valid values: inherit,adom. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit.
- Srcaddr6s []string
- Select an IPv6 source address. Required for web proxy authentication.
- Srcaddrs []string
- Select an IPv4 source address from available options. Required for web proxy authentication.
- Srcintfs []string
- Incoming (ingress) interface.
- SsoAuth stringMethod 
- Select a single-sign on (SSO) authentication method.
- Status string
- Enable/disable this authentication rule. Valid values: disable,enable.
- TransactionBased string
- Enable/disable transaction based authentication (default = disable). Valid values: disable,enable.
- string
- Enable/disable Web authentication cookies (default = disable). Valid values: disable,enable.
- WebPortal string
- Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable,enable.
- pkg String
- Package.
- activeAuth StringMethod 
- Select an active authentication method.
- adom String
- Adom. This value is valid only when the scopetypeisadom, otherwise the value of adom in the provider will be inherited.
- String
- Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable,enable.
- comments String
- Comment.
- corsDepth Double
- Depth to allow CORS access (default = 3).
- corsStateful String
- Enable/disable allowance of CORS access (default = disable). Valid values: disable,enable.
- dstaddr6s List<String>
- Select an IPv6 destination address from available options. Required for web proxy authentication.
- dstaddrs List<String>
- Select an IPv4 destination address from available options. Required for web proxy authentication.
- ipBased String
- Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable,enable.
- name String
- Authentication rule name.
- packagesAuthentication StringRule Id 
- an identifier for the resource with format {{name}}.
- pkgFolder StringPath 
- Pkg Folder Path.
- protocol String
- Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http,ftp,socks,ssh.
- scopetype String
- The scope of application of the resource. Valid values: inherit,adom. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit.
- srcaddr6s List<String>
- Select an IPv6 source address. Required for web proxy authentication.
- srcaddrs List<String>
- Select an IPv4 source address from available options. Required for web proxy authentication.
- srcintfs List<String>
- Incoming (ingress) interface.
- ssoAuth StringMethod 
- Select a single-sign on (SSO) authentication method.
- status String
- Enable/disable this authentication rule. Valid values: disable,enable.
- transactionBased String
- Enable/disable transaction based authentication (default = disable). Valid values: disable,enable.
- String
- Enable/disable Web authentication cookies (default = disable). Valid values: disable,enable.
- webPortal String
- Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable,enable.
- pkg string
- Package.
- activeAuth stringMethod 
- Select an active authentication method.
- adom string
- Adom. This value is valid only when the scopetypeisadom, otherwise the value of adom in the provider will be inherited.
- string
- Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable,enable.
- comments string
- Comment.
- corsDepth number
- Depth to allow CORS access (default = 3).
- corsStateful string
- Enable/disable allowance of CORS access (default = disable). Valid values: disable,enable.
- dstaddr6s string[]
- Select an IPv6 destination address from available options. Required for web proxy authentication.
- dstaddrs string[]
- Select an IPv4 destination address from available options. Required for web proxy authentication.
- ipBased string
- Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable,enable.
- name string
- Authentication rule name.
- packagesAuthentication stringRule Id 
- an identifier for the resource with format {{name}}.
- pkgFolder stringPath 
- Pkg Folder Path.
- protocol string
- Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http,ftp,socks,ssh.
- scopetype string
- The scope of application of the resource. Valid values: inherit,adom. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit.
- srcaddr6s string[]
- Select an IPv6 source address. Required for web proxy authentication.
- srcaddrs string[]
- Select an IPv4 source address from available options. Required for web proxy authentication.
- srcintfs string[]
- Incoming (ingress) interface.
- ssoAuth stringMethod 
- Select a single-sign on (SSO) authentication method.
- status string
- Enable/disable this authentication rule. Valid values: disable,enable.
- transactionBased string
- Enable/disable transaction based authentication (default = disable). Valid values: disable,enable.
- string
- Enable/disable Web authentication cookies (default = disable). Valid values: disable,enable.
- webPortal string
- Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable,enable.
- pkg str
- Package.
- active_auth_ strmethod 
- Select an active authentication method.
- adom str
- Adom. This value is valid only when the scopetypeisadom, otherwise the value of adom in the provider will be inherited.
- str
- Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable,enable.
- comments str
- Comment.
- cors_depth float
- Depth to allow CORS access (default = 3).
- cors_stateful str
- Enable/disable allowance of CORS access (default = disable). Valid values: disable,enable.
- dstaddr6s Sequence[str]
- Select an IPv6 destination address from available options. Required for web proxy authentication.
- dstaddrs Sequence[str]
- Select an IPv4 destination address from available options. Required for web proxy authentication.
- ip_based str
- Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable,enable.
- name str
- Authentication rule name.
- packages_authentication_ strrule_ id 
- an identifier for the resource with format {{name}}.
- pkg_folder_ strpath 
- Pkg Folder Path.
- protocol str
- Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http,ftp,socks,ssh.
- scopetype str
- The scope of application of the resource. Valid values: inherit,adom. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit.
- srcaddr6s Sequence[str]
- Select an IPv6 source address. Required for web proxy authentication.
- srcaddrs Sequence[str]
- Select an IPv4 source address from available options. Required for web proxy authentication.
- srcintfs Sequence[str]
- Incoming (ingress) interface.
- sso_auth_ strmethod 
- Select a single-sign on (SSO) authentication method.
- status str
- Enable/disable this authentication rule. Valid values: disable,enable.
- transaction_based str
- Enable/disable transaction based authentication (default = disable). Valid values: disable,enable.
- str
- Enable/disable Web authentication cookies (default = disable). Valid values: disable,enable.
- web_portal str
- Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable,enable.
- pkg String
- Package.
- activeAuth StringMethod 
- Select an active authentication method.
- adom String
- Adom. This value is valid only when the scopetypeisadom, otherwise the value of adom in the provider will be inherited.
- String
- Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable,enable.
- comments String
- Comment.
- corsDepth Number
- Depth to allow CORS access (default = 3).
- corsStateful String
- Enable/disable allowance of CORS access (default = disable). Valid values: disable,enable.
- dstaddr6s List<String>
- Select an IPv6 destination address from available options. Required for web proxy authentication.
- dstaddrs List<String>
- Select an IPv4 destination address from available options. Required for web proxy authentication.
- ipBased String
- Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable,enable.
- name String
- Authentication rule name.
- packagesAuthentication StringRule Id 
- an identifier for the resource with format {{name}}.
- pkgFolder StringPath 
- Pkg Folder Path.
- protocol String
- Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http,ftp,socks,ssh.
- scopetype String
- The scope of application of the resource. Valid values: inherit,adom. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit.
- srcaddr6s List<String>
- Select an IPv6 source address. Required for web proxy authentication.
- srcaddrs List<String>
- Select an IPv4 source address from available options. Required for web proxy authentication.
- srcintfs List<String>
- Incoming (ingress) interface.
- ssoAuth StringMethod 
- Select a single-sign on (SSO) authentication method.
- status String
- Enable/disable this authentication rule. Valid values: disable,enable.
- transactionBased String
- Enable/disable transaction based authentication (default = disable). Valid values: disable,enable.
- String
- Enable/disable Web authentication cookies (default = disable). Valid values: disable,enable.
- webPortal String
- Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable,enable.
Outputs
All input properties are implicitly available as output properties. Additionally, the PackagesAuthenticationRule resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing PackagesAuthenticationRule Resource
Get an existing PackagesAuthenticationRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PackagesAuthenticationRuleState, opts?: CustomResourceOptions): PackagesAuthenticationRule@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active_auth_method: Optional[str] = None,
        adom: Optional[str] = None,
        cert_auth_cookie: Optional[str] = None,
        comments: Optional[str] = None,
        cors_depth: Optional[float] = None,
        cors_stateful: Optional[str] = None,
        dstaddr6s: Optional[Sequence[str]] = None,
        dstaddrs: Optional[Sequence[str]] = None,
        ip_based: Optional[str] = None,
        name: Optional[str] = None,
        packages_authentication_rule_id: Optional[str] = None,
        pkg: Optional[str] = None,
        pkg_folder_path: Optional[str] = None,
        protocol: Optional[str] = None,
        scopetype: Optional[str] = None,
        srcaddr6s: Optional[Sequence[str]] = None,
        srcaddrs: Optional[Sequence[str]] = None,
        srcintfs: Optional[Sequence[str]] = None,
        sso_auth_method: Optional[str] = None,
        status: Optional[str] = None,
        transaction_based: Optional[str] = None,
        web_auth_cookie: Optional[str] = None,
        web_portal: Optional[str] = None) -> PackagesAuthenticationRulefunc GetPackagesAuthenticationRule(ctx *Context, name string, id IDInput, state *PackagesAuthenticationRuleState, opts ...ResourceOption) (*PackagesAuthenticationRule, error)public static PackagesAuthenticationRule Get(string name, Input<string> id, PackagesAuthenticationRuleState? state, CustomResourceOptions? opts = null)public static PackagesAuthenticationRule get(String name, Output<String> id, PackagesAuthenticationRuleState state, CustomResourceOptions options)resources:  _:    type: fortimanager:PackagesAuthenticationRule    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- ActiveAuth stringMethod 
- Select an active authentication method.
- Adom string
- Adom. This value is valid only when the scopetypeisadom, otherwise the value of adom in the provider will be inherited.
- string
- Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable,enable.
- Comments string
- Comment.
- CorsDepth double
- Depth to allow CORS access (default = 3).
- CorsStateful string
- Enable/disable allowance of CORS access (default = disable). Valid values: disable,enable.
- Dstaddr6s List<string>
- Select an IPv6 destination address from available options. Required for web proxy authentication.
- Dstaddrs List<string>
- Select an IPv4 destination address from available options. Required for web proxy authentication.
- IpBased string
- Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable,enable.
- Name string
- Authentication rule name.
- PackagesAuthentication stringRule Id 
- an identifier for the resource with format {{name}}.
- Pkg string
- Package.
- PkgFolder stringPath 
- Pkg Folder Path.
- Protocol string
- Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http,ftp,socks,ssh.
- Scopetype string
- The scope of application of the resource. Valid values: inherit,adom. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit.
- Srcaddr6s List<string>
- Select an IPv6 source address. Required for web proxy authentication.
- Srcaddrs List<string>
- Select an IPv4 source address from available options. Required for web proxy authentication.
- Srcintfs List<string>
- Incoming (ingress) interface.
- SsoAuth stringMethod 
- Select a single-sign on (SSO) authentication method.
- Status string
- Enable/disable this authentication rule. Valid values: disable,enable.
- TransactionBased string
- Enable/disable transaction based authentication (default = disable). Valid values: disable,enable.
- string
- Enable/disable Web authentication cookies (default = disable). Valid values: disable,enable.
- WebPortal string
- Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable,enable.
- ActiveAuth stringMethod 
- Select an active authentication method.
- Adom string
- Adom. This value is valid only when the scopetypeisadom, otherwise the value of adom in the provider will be inherited.
- string
- Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable,enable.
- Comments string
- Comment.
- CorsDepth float64
- Depth to allow CORS access (default = 3).
- CorsStateful string
- Enable/disable allowance of CORS access (default = disable). Valid values: disable,enable.
- Dstaddr6s []string
- Select an IPv6 destination address from available options. Required for web proxy authentication.
- Dstaddrs []string
- Select an IPv4 destination address from available options. Required for web proxy authentication.
- IpBased string
- Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable,enable.
- Name string
- Authentication rule name.
- PackagesAuthentication stringRule Id 
- an identifier for the resource with format {{name}}.
- Pkg string
- Package.
- PkgFolder stringPath 
- Pkg Folder Path.
- Protocol string
- Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http,ftp,socks,ssh.
- Scopetype string
- The scope of application of the resource. Valid values: inherit,adom. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit.
- Srcaddr6s []string
- Select an IPv6 source address. Required for web proxy authentication.
- Srcaddrs []string
- Select an IPv4 source address from available options. Required for web proxy authentication.
- Srcintfs []string
- Incoming (ingress) interface.
- SsoAuth stringMethod 
- Select a single-sign on (SSO) authentication method.
- Status string
- Enable/disable this authentication rule. Valid values: disable,enable.
- TransactionBased string
- Enable/disable transaction based authentication (default = disable). Valid values: disable,enable.
- string
- Enable/disable Web authentication cookies (default = disable). Valid values: disable,enable.
- WebPortal string
- Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable,enable.
- activeAuth StringMethod 
- Select an active authentication method.
- adom String
- Adom. This value is valid only when the scopetypeisadom, otherwise the value of adom in the provider will be inherited.
- String
- Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable,enable.
- comments String
- Comment.
- corsDepth Double
- Depth to allow CORS access (default = 3).
- corsStateful String
- Enable/disable allowance of CORS access (default = disable). Valid values: disable,enable.
- dstaddr6s List<String>
- Select an IPv6 destination address from available options. Required for web proxy authentication.
- dstaddrs List<String>
- Select an IPv4 destination address from available options. Required for web proxy authentication.
- ipBased String
- Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable,enable.
- name String
- Authentication rule name.
- packagesAuthentication StringRule Id 
- an identifier for the resource with format {{name}}.
- pkg String
- Package.
- pkgFolder StringPath 
- Pkg Folder Path.
- protocol String
- Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http,ftp,socks,ssh.
- scopetype String
- The scope of application of the resource. Valid values: inherit,adom. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit.
- srcaddr6s List<String>
- Select an IPv6 source address. Required for web proxy authentication.
- srcaddrs List<String>
- Select an IPv4 source address from available options. Required for web proxy authentication.
- srcintfs List<String>
- Incoming (ingress) interface.
- ssoAuth StringMethod 
- Select a single-sign on (SSO) authentication method.
- status String
- Enable/disable this authentication rule. Valid values: disable,enable.
- transactionBased String
- Enable/disable transaction based authentication (default = disable). Valid values: disable,enable.
- String
- Enable/disable Web authentication cookies (default = disable). Valid values: disable,enable.
- webPortal String
- Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable,enable.
- activeAuth stringMethod 
- Select an active authentication method.
- adom string
- Adom. This value is valid only when the scopetypeisadom, otherwise the value of adom in the provider will be inherited.
- string
- Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable,enable.
- comments string
- Comment.
- corsDepth number
- Depth to allow CORS access (default = 3).
- corsStateful string
- Enable/disable allowance of CORS access (default = disable). Valid values: disable,enable.
- dstaddr6s string[]
- Select an IPv6 destination address from available options. Required for web proxy authentication.
- dstaddrs string[]
- Select an IPv4 destination address from available options. Required for web proxy authentication.
- ipBased string
- Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable,enable.
- name string
- Authentication rule name.
- packagesAuthentication stringRule Id 
- an identifier for the resource with format {{name}}.
- pkg string
- Package.
- pkgFolder stringPath 
- Pkg Folder Path.
- protocol string
- Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http,ftp,socks,ssh.
- scopetype string
- The scope of application of the resource. Valid values: inherit,adom. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit.
- srcaddr6s string[]
- Select an IPv6 source address. Required for web proxy authentication.
- srcaddrs string[]
- Select an IPv4 source address from available options. Required for web proxy authentication.
- srcintfs string[]
- Incoming (ingress) interface.
- ssoAuth stringMethod 
- Select a single-sign on (SSO) authentication method.
- status string
- Enable/disable this authentication rule. Valid values: disable,enable.
- transactionBased string
- Enable/disable transaction based authentication (default = disable). Valid values: disable,enable.
- string
- Enable/disable Web authentication cookies (default = disable). Valid values: disable,enable.
- webPortal string
- Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable,enable.
- active_auth_ strmethod 
- Select an active authentication method.
- adom str
- Adom. This value is valid only when the scopetypeisadom, otherwise the value of adom in the provider will be inherited.
- str
- Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable,enable.
- comments str
- Comment.
- cors_depth float
- Depth to allow CORS access (default = 3).
- cors_stateful str
- Enable/disable allowance of CORS access (default = disable). Valid values: disable,enable.
- dstaddr6s Sequence[str]
- Select an IPv6 destination address from available options. Required for web proxy authentication.
- dstaddrs Sequence[str]
- Select an IPv4 destination address from available options. Required for web proxy authentication.
- ip_based str
- Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable,enable.
- name str
- Authentication rule name.
- packages_authentication_ strrule_ id 
- an identifier for the resource with format {{name}}.
- pkg str
- Package.
- pkg_folder_ strpath 
- Pkg Folder Path.
- protocol str
- Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http,ftp,socks,ssh.
- scopetype str
- The scope of application of the resource. Valid values: inherit,adom. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit.
- srcaddr6s Sequence[str]
- Select an IPv6 source address. Required for web proxy authentication.
- srcaddrs Sequence[str]
- Select an IPv4 source address from available options. Required for web proxy authentication.
- srcintfs Sequence[str]
- Incoming (ingress) interface.
- sso_auth_ strmethod 
- Select a single-sign on (SSO) authentication method.
- status str
- Enable/disable this authentication rule. Valid values: disable,enable.
- transaction_based str
- Enable/disable transaction based authentication (default = disable). Valid values: disable,enable.
- str
- Enable/disable Web authentication cookies (default = disable). Valid values: disable,enable.
- web_portal str
- Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable,enable.
- activeAuth StringMethod 
- Select an active authentication method.
- adom String
- Adom. This value is valid only when the scopetypeisadom, otherwise the value of adom in the provider will be inherited.
- String
- Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable,enable.
- comments String
- Comment.
- corsDepth Number
- Depth to allow CORS access (default = 3).
- corsStateful String
- Enable/disable allowance of CORS access (default = disable). Valid values: disable,enable.
- dstaddr6s List<String>
- Select an IPv6 destination address from available options. Required for web proxy authentication.
- dstaddrs List<String>
- Select an IPv4 destination address from available options. Required for web proxy authentication.
- ipBased String
- Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable,enable.
- name String
- Authentication rule name.
- packagesAuthentication StringRule Id 
- an identifier for the resource with format {{name}}.
- pkg String
- Package.
- pkgFolder StringPath 
- Pkg Folder Path.
- protocol String
- Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http,ftp,socks,ssh.
- scopetype String
- The scope of application of the resource. Valid values: inherit,adom. Theinheritmeans that the scopetype of the provider will be inherited, and adom will also be inherited. The default value isinherit.
- srcaddr6s List<String>
- Select an IPv6 source address. Required for web proxy authentication.
- srcaddrs List<String>
- Select an IPv4 source address from available options. Required for web proxy authentication.
- srcintfs List<String>
- Incoming (ingress) interface.
- ssoAuth StringMethod 
- Select a single-sign on (SSO) authentication method.
- status String
- Enable/disable this authentication rule. Valid values: disable,enable.
- transactionBased String
- Enable/disable transaction based authentication (default = disable). Valid values: disable,enable.
- String
- Enable/disable Web authentication cookies (default = disable). Valid values: disable,enable.
- webPortal String
- Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable,enable.
Import
Packages AuthenticationRule can be imported using any of these accepted formats:
Set import_options = [“pkg_folder_path=YOUR_VALUE”, “pkg=YOUR_VALUE”] in the provider section.
$ export “FORTIMANAGER_IMPORT_TABLE”=“true”
$ pulumi import fortimanager:index/packagesAuthenticationRule:PackagesAuthenticationRule labelname {{name}}
$ unset “FORTIMANAGER_IMPORT_TABLE”
-> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- fortimanager fortinetdev/terraform-provider-fortimanager
- License
- Notes
- This Pulumi package is based on the fortimanagerTerraform Provider.