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

fortios.wirelesscontroller.Wagprofile

Explore with Pulumi AI

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

    Configure wireless access gateway (WAG) profiles used for tunnels on AP. Applies to FortiOS Version >= 6.2.4.

    Create Wagprofile Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Wagprofile(name: string, args?: WagprofileArgs, opts?: CustomResourceOptions);
    @overload
def Wagprofile(resource_name: str,
               args: Optional[WagprofileArgs] = None,
               opts: Optional[ResourceOptions] = None)

@overload
def Wagprofile(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               comment: Optional[str] = None,
               dhcp_ip_addr: Optional[str] = None,
               name: Optional[str] = None,
               ping_interval: Optional[int] = None,
               ping_number: Optional[int] = None,
               return_packet_timeout: Optional[int] = None,
               tunnel_type: Optional[str] = None,
               vdomparam: Optional[str] = None,
               wag_ip: Optional[str] = None,
               wag_port: Optional[int] = None)
    func NewWagprofile(ctx *Context, name string, args *WagprofileArgs, opts ...ResourceOption) (*Wagprofile, error)
    public Wagprofile(string name, WagprofileArgs? args = null, CustomResourceOptions? opts = null)
    public Wagprofile(String name, WagprofileArgs args)
public Wagprofile(String name, WagprofileArgs args, CustomResourceOptions options)

    type: fortios:wirelesscontroller:Wagprofile
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 WagprofileArgs
    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 WagprofileArgs
    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 WagprofileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WagprofileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WagprofileArgs
    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 wagprofileResource = new Fortios.Wirelesscontroller.Wagprofile("wagprofileResource", new()
{
    Comment = "string",
    DhcpIpAddr = "string",
    Name = "string",
    PingInterval = 0,
    PingNumber = 0,
    ReturnPacketTimeout = 0,
    TunnelType = "string",
    Vdomparam = "string",
    WagIp = "string",
    WagPort = 0,
});

    example, err := wirelesscontroller.NewWagprofile(ctx, "wagprofileResource", &wirelesscontroller.WagprofileArgs{
	Comment:             pulumi.String("string"),
	DhcpIpAddr:          pulumi.String("string"),
	Name:                pulumi.String("string"),
	PingInterval:        pulumi.Int(0),
	PingNumber:          pulumi.Int(0),
	ReturnPacketTimeout: pulumi.Int(0),
	TunnelType:          pulumi.String("string"),
	Vdomparam:           pulumi.String("string"),
	WagIp:               pulumi.String("string"),
	WagPort:             pulumi.Int(0),
})

    var wagprofileResource = new Wagprofile("wagprofileResource", WagprofileArgs.builder()
    .comment("string")
    .dhcpIpAddr("string")
    .name("string")
    .pingInterval(0)
    .pingNumber(0)
    .returnPacketTimeout(0)
    .tunnelType("string")
    .vdomparam("string")
    .wagIp("string")
    .wagPort(0)
    .build());

    wagprofile_resource = fortios.wirelesscontroller.Wagprofile("wagprofileResource",
    comment="string",
    dhcp_ip_addr="string",
    name="string",
    ping_interval=0,
    ping_number=0,
    return_packet_timeout=0,
    tunnel_type="string",
    vdomparam="string",
    wag_ip="string",
    wag_port=0)

    const wagprofileResource = new fortios.wirelesscontroller.Wagprofile("wagprofileResource", {
    comment: "string",
    dhcpIpAddr: "string",
    name: "string",
    pingInterval: 0,
    pingNumber: 0,
    returnPacketTimeout: 0,
    tunnelType: "string",
    vdomparam: "string",
    wagIp: "string",
    wagPort: 0,
});

    type: fortios:wirelesscontroller:Wagprofile
properties:
    comment: string
    dhcpIpAddr: string
    name: string
    pingInterval: 0
    pingNumber: 0
    returnPacketTimeout: 0
    tunnelType: string
    vdomparam: string
    wagIp: string
    wagPort: 0

    Wagprofile Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Wagprofile resource accepts the following input properties:

    Comment string
    Comment.
    DhcpIpAddr string
    IP address of the monitoring DHCP request packet sent through the tunnel.
    Name string
    Tunnel profile name.
    PingInterval int
    Interval between two tunnel monitoring echo packets (1 - 65535 sec, default = 1).
    PingNumber int
    Number of the tunnel monitoring echo packets (1 - 65535, default = 5).
    ReturnPacketTimeout int
    Window of time for the return packets from the tunnel's remote end (1 - 65535 sec, default = 160).
    TunnelType string
    Tunnel type. Valid values: l2tpv3, gre.
    Vdomparam string
    Specifies the vdom to which the resource 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.
    WagIp string
    IP Address of the wireless access gateway.
    WagPort int
    UDP port of the wireless access gateway.
    Comment string
    Comment.
    DhcpIpAddr string
    IP address of the monitoring DHCP request packet sent through the tunnel.
    Name string
    Tunnel profile name.
    PingInterval int
    Interval between two tunnel monitoring echo packets (1 - 65535 sec, default = 1).
    PingNumber int
    Number of the tunnel monitoring echo packets (1 - 65535, default = 5).
    ReturnPacketTimeout int
    Window of time for the return packets from the tunnel's remote end (1 - 65535 sec, default = 160).
    TunnelType string
    Tunnel type. Valid values: l2tpv3, gre.
    Vdomparam string
    Specifies the vdom to which the resource 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.
    WagIp string
    IP Address of the wireless access gateway.
    WagPort int
    UDP port of the wireless access gateway.
    comment String
    Comment.
    dhcpIpAddr String
    IP address of the monitoring DHCP request packet sent through the tunnel.
    name String
    Tunnel profile name.
    pingInterval Integer
    Interval between two tunnel monitoring echo packets (1 - 65535 sec, default = 1).
    pingNumber Integer
    Number of the tunnel monitoring echo packets (1 - 65535, default = 5).
    returnPacketTimeout Integer
    Window of time for the return packets from the tunnel's remote end (1 - 65535 sec, default = 160).
    tunnelType String
    Tunnel type. Valid values: l2tpv3, gre.
    vdomparam String
    Specifies the vdom to which the resource 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.
    wagIp String
    IP Address of the wireless access gateway.
    wagPort Integer
    UDP port of the wireless access gateway.
    comment string
    Comment.
    dhcpIpAddr string
    IP address of the monitoring DHCP request packet sent through the tunnel.
    name string
    Tunnel profile name.
    pingInterval number
    Interval between two tunnel monitoring echo packets (1 - 65535 sec, default = 1).
    pingNumber number
    Number of the tunnel monitoring echo packets (1 - 65535, default = 5).
    returnPacketTimeout number
    Window of time for the return packets from the tunnel's remote end (1 - 65535 sec, default = 160).
    tunnelType string
    Tunnel type. Valid values: l2tpv3, gre.
    vdomparam string
    Specifies the vdom to which the resource 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.
    wagIp string
    IP Address of the wireless access gateway.
    wagPort number
    UDP port of the wireless access gateway.
    comment str
    Comment.
    dhcp_ip_addr str
    IP address of the monitoring DHCP request packet sent through the tunnel.
    name str
    Tunnel profile name.
    ping_interval int
    Interval between two tunnel monitoring echo packets (1 - 65535 sec, default = 1).
    ping_number int
    Number of the tunnel monitoring echo packets (1 - 65535, default = 5).
    return_packet_timeout int
    Window of time for the return packets from the tunnel's remote end (1 - 65535 sec, default = 160).
    tunnel_type str
    Tunnel type. Valid values: l2tpv3, gre.
    vdomparam str
    Specifies the vdom to which the resource 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.
    wag_ip str
    IP Address of the wireless access gateway.
    wag_port int
    UDP port of the wireless access gateway.
    comment String
    Comment.
    dhcpIpAddr String
    IP address of the monitoring DHCP request packet sent through the tunnel.
    name String
    Tunnel profile name.
    pingInterval Number
    Interval between two tunnel monitoring echo packets (1 - 65535 sec, default = 1).
    pingNumber Number
    Number of the tunnel monitoring echo packets (1 - 65535, default = 5).
    returnPacketTimeout Number
    Window of time for the return packets from the tunnel's remote end (1 - 65535 sec, default = 160).
    tunnelType String
    Tunnel type. Valid values: l2tpv3, gre.
    vdomparam String
    Specifies the vdom to which the resource 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.
    wagIp String
    IP Address of the wireless access gateway.
    wagPort Number
    UDP port of the wireless access gateway.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Wagprofile 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 Wagprofile Resource

    Get an existing Wagprofile 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?: WagprofileState, opts?: CustomResourceOptions): Wagprofile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        dhcp_ip_addr: Optional[str] = None,
        name: Optional[str] = None,
        ping_interval: Optional[int] = None,
        ping_number: Optional[int] = None,
        return_packet_timeout: Optional[int] = None,
        tunnel_type: Optional[str] = None,
        vdomparam: Optional[str] = None,
        wag_ip: Optional[str] = None,
        wag_port: Optional[int] = None) -> Wagprofile
    func GetWagprofile(ctx *Context, name string, id IDInput, state *WagprofileState, opts ...ResourceOption) (*Wagprofile, error)
    public static Wagprofile Get(string name, Input<string> id, WagprofileState? state, CustomResourceOptions? opts = null)
    public static Wagprofile get(String name, Output<String> id, WagprofileState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    Comment string
    Comment.
    DhcpIpAddr string
    IP address of the monitoring DHCP request packet sent through the tunnel.
    Name string
    Tunnel profile name.
    PingInterval int
    Interval between two tunnel monitoring echo packets (1 - 65535 sec, default = 1).
    PingNumber int
    Number of the tunnel monitoring echo packets (1 - 65535, default = 5).
    ReturnPacketTimeout int
    Window of time for the return packets from the tunnel's remote end (1 - 65535 sec, default = 160).
    TunnelType string
    Tunnel type. Valid values: l2tpv3, gre.
    Vdomparam string
    Specifies the vdom to which the resource 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.
    WagIp string
    IP Address of the wireless access gateway.
    WagPort int
    UDP port of the wireless access gateway.
    Comment string
    Comment.
    DhcpIpAddr string
    IP address of the monitoring DHCP request packet sent through the tunnel.
    Name string
    Tunnel profile name.
    PingInterval int
    Interval between two tunnel monitoring echo packets (1 - 65535 sec, default = 1).
    PingNumber int
    Number of the tunnel monitoring echo packets (1 - 65535, default = 5).
    ReturnPacketTimeout int
    Window of time for the return packets from the tunnel's remote end (1 - 65535 sec, default = 160).
    TunnelType string
    Tunnel type. Valid values: l2tpv3, gre.
    Vdomparam string
    Specifies the vdom to which the resource 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.
    WagIp string
    IP Address of the wireless access gateway.
    WagPort int
    UDP port of the wireless access gateway.
    comment String
    Comment.
    dhcpIpAddr String
    IP address of the monitoring DHCP request packet sent through the tunnel.
    name String
    Tunnel profile name.
    pingInterval Integer
    Interval between two tunnel monitoring echo packets (1 - 65535 sec, default = 1).
    pingNumber Integer
    Number of the tunnel monitoring echo packets (1 - 65535, default = 5).
    returnPacketTimeout Integer
    Window of time for the return packets from the tunnel's remote end (1 - 65535 sec, default = 160).
    tunnelType String
    Tunnel type. Valid values: l2tpv3, gre.
    vdomparam String
    Specifies the vdom to which the resource 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.
    wagIp String
    IP Address of the wireless access gateway.
    wagPort Integer
    UDP port of the wireless access gateway.
    comment string
    Comment.
    dhcpIpAddr string
    IP address of the monitoring DHCP request packet sent through the tunnel.
    name string
    Tunnel profile name.
    pingInterval number
    Interval between two tunnel monitoring echo packets (1 - 65535 sec, default = 1).
    pingNumber number
    Number of the tunnel monitoring echo packets (1 - 65535, default = 5).
    returnPacketTimeout number
    Window of time for the return packets from the tunnel's remote end (1 - 65535 sec, default = 160).
    tunnelType string
    Tunnel type. Valid values: l2tpv3, gre.
    vdomparam string
    Specifies the vdom to which the resource 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.
    wagIp string
    IP Address of the wireless access gateway.
    wagPort number
    UDP port of the wireless access gateway.
    comment str
    Comment.
    dhcp_ip_addr str
    IP address of the monitoring DHCP request packet sent through the tunnel.
    name str
    Tunnel profile name.
    ping_interval int
    Interval between two tunnel monitoring echo packets (1 - 65535 sec, default = 1).
    ping_number int
    Number of the tunnel monitoring echo packets (1 - 65535, default = 5).
    return_packet_timeout int
    Window of time for the return packets from the tunnel's remote end (1 - 65535 sec, default = 160).
    tunnel_type str
    Tunnel type. Valid values: l2tpv3, gre.
    vdomparam str
    Specifies the vdom to which the resource 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.
    wag_ip str
    IP Address of the wireless access gateway.
    wag_port int
    UDP port of the wireless access gateway.
    comment String
    Comment.
    dhcpIpAddr String
    IP address of the monitoring DHCP request packet sent through the tunnel.
    name String
    Tunnel profile name.
    pingInterval Number
    Interval between two tunnel monitoring echo packets (1 - 65535 sec, default = 1).
    pingNumber Number
    Number of the tunnel monitoring echo packets (1 - 65535, default = 5).
    returnPacketTimeout Number
    Window of time for the return packets from the tunnel's remote end (1 - 65535 sec, default = 160).
    tunnelType String
    Tunnel type. Valid values: l2tpv3, gre.
    vdomparam String
    Specifies the vdom to which the resource 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.
    wagIp String
    IP Address of the wireless access gateway.
    wagPort Number
    UDP port of the wireless access gateway.

    Import

    WirelessController WagProfile can be imported using any of these accepted formats:

    $ pulumi import fortios:wirelesscontroller/wagprofile:Wagprofile labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:wirelesscontroller/wagprofile:Wagprofile labelname {{name}}

    $ unset “FORTIOS_IMPORT_TABLE”

    To learn more about importing existing cloud resources, see Importing resources.

    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