1. Packages
  2. Fortios
  3. API Docs
  4. wanopt
  5. Authgroup
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.wanopt.Authgroup

Explore with Pulumi AI

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

    Configure WAN optimization authentication groups.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fortios from "@pulumiverse/fortios";
    
    const trname = new fortios.wanopt.Authgroup("trname", {
        authMethod: "cert",
        cert: "Fortinet_CA_SSL",
        peerAccept: "any",
    });
    
    import pulumi
    import pulumiverse_fortios as fortios
    
    trname = fortios.wanopt.Authgroup("trname",
        auth_method="cert",
        cert="Fortinet_CA_SSL",
        peer_accept="any")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/wanopt"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := wanopt.NewAuthgroup(ctx, "trname", &wanopt.AuthgroupArgs{
    			AuthMethod: pulumi.String("cert"),
    			Cert:       pulumi.String("Fortinet_CA_SSL"),
    			PeerAccept: pulumi.String("any"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Fortios = Pulumiverse.Fortios;
    
    return await Deployment.RunAsync(() => 
    {
        var trname = new Fortios.Wanopt.Authgroup("trname", new()
        {
            AuthMethod = "cert",
            Cert = "Fortinet_CA_SSL",
            PeerAccept = "any",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fortios.wanopt.Authgroup;
    import com.pulumi.fortios.wanopt.AuthgroupArgs;
    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 trname = new Authgroup("trname", AuthgroupArgs.builder()        
                .authMethod("cert")
                .cert("Fortinet_CA_SSL")
                .peerAccept("any")
                .build());
    
        }
    }
    
    resources:
      trname:
        type: fortios:wanopt:Authgroup
        properties:
          authMethod: cert
          cert: Fortinet_CA_SSL
          peerAccept: any
    

    Create Authgroup Resource

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

    Constructor syntax

    new Authgroup(name: string, args: AuthgroupArgs, opts?: CustomResourceOptions);
    @overload
    def Authgroup(resource_name: str,
                  args: AuthgroupArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Authgroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  cert: Optional[str] = None,
                  auth_method: Optional[str] = None,
                  name: Optional[str] = None,
                  peer: Optional[str] = None,
                  peer_accept: Optional[str] = None,
                  psk: Optional[str] = None,
                  vdomparam: Optional[str] = None)
    func NewAuthgroup(ctx *Context, name string, args AuthgroupArgs, opts ...ResourceOption) (*Authgroup, error)
    public Authgroup(string name, AuthgroupArgs args, CustomResourceOptions? opts = null)
    public Authgroup(String name, AuthgroupArgs args)
    public Authgroup(String name, AuthgroupArgs args, CustomResourceOptions options)
    
    type: fortios:wanopt:Authgroup
    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 AuthgroupArgs
    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 AuthgroupArgs
    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 AuthgroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthgroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthgroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var authgroupResource = new Fortios.Wanopt.Authgroup("authgroupResource", new()
    {
        Cert = "string",
        AuthMethod = "string",
        Name = "string",
        Peer = "string",
        PeerAccept = "string",
        Psk = "string",
        Vdomparam = "string",
    });
    
    example, err := wanopt.NewAuthgroup(ctx, "authgroupResource", &wanopt.AuthgroupArgs{
    	Cert:       pulumi.String("string"),
    	AuthMethod: pulumi.String("string"),
    	Name:       pulumi.String("string"),
    	Peer:       pulumi.String("string"),
    	PeerAccept: pulumi.String("string"),
    	Psk:        pulumi.String("string"),
    	Vdomparam:  pulumi.String("string"),
    })
    
    var authgroupResource = new Authgroup("authgroupResource", AuthgroupArgs.builder()        
        .cert("string")
        .authMethod("string")
        .name("string")
        .peer("string")
        .peerAccept("string")
        .psk("string")
        .vdomparam("string")
        .build());
    
    authgroup_resource = fortios.wanopt.Authgroup("authgroupResource",
        cert="string",
        auth_method="string",
        name="string",
        peer="string",
        peer_accept="string",
        psk="string",
        vdomparam="string")
    
    const authgroupResource = new fortios.wanopt.Authgroup("authgroupResource", {
        cert: "string",
        authMethod: "string",
        name: "string",
        peer: "string",
        peerAccept: "string",
        psk: "string",
        vdomparam: "string",
    });
    
    type: fortios:wanopt:Authgroup
    properties:
        authMethod: string
        cert: string
        name: string
        peer: string
        peerAccept: string
        psk: string
        vdomparam: string
    

    Authgroup 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 Authgroup resource accepts the following input properties:

    Cert string
    Name of certificate to identify this peer.
    AuthMethod string
    Select certificate or pre-shared key authentication for this authentication group. Valid values: cert, psk.
    Name string
    Auth-group name.
    Peer string
    If peer-accept is set to one, select the name of one peer to add to this authentication group. The peer must have added with the wanopt peer command.
    PeerAccept string
    Determine if this auth group accepts, any peer, a list of defined peers, or just one peer. Valid values: any, defined, one.
    Psk string
    Pre-shared key used by the peers in this authentication group.
    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.
    Cert string
    Name of certificate to identify this peer.
    AuthMethod string
    Select certificate or pre-shared key authentication for this authentication group. Valid values: cert, psk.
    Name string
    Auth-group name.
    Peer string
    If peer-accept is set to one, select the name of one peer to add to this authentication group. The peer must have added with the wanopt peer command.
    PeerAccept string
    Determine if this auth group accepts, any peer, a list of defined peers, or just one peer. Valid values: any, defined, one.
    Psk string
    Pre-shared key used by the peers in this authentication group.
    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.
    cert String
    Name of certificate to identify this peer.
    authMethod String
    Select certificate or pre-shared key authentication for this authentication group. Valid values: cert, psk.
    name String
    Auth-group name.
    peer String
    If peer-accept is set to one, select the name of one peer to add to this authentication group. The peer must have added with the wanopt peer command.
    peerAccept String
    Determine if this auth group accepts, any peer, a list of defined peers, or just one peer. Valid values: any, defined, one.
    psk String
    Pre-shared key used by the peers in this authentication group.
    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.
    cert string
    Name of certificate to identify this peer.
    authMethod string
    Select certificate or pre-shared key authentication for this authentication group. Valid values: cert, psk.
    name string
    Auth-group name.
    peer string
    If peer-accept is set to one, select the name of one peer to add to this authentication group. The peer must have added with the wanopt peer command.
    peerAccept string
    Determine if this auth group accepts, any peer, a list of defined peers, or just one peer. Valid values: any, defined, one.
    psk string
    Pre-shared key used by the peers in this authentication group.
    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.
    cert str
    Name of certificate to identify this peer.
    auth_method str
    Select certificate or pre-shared key authentication for this authentication group. Valid values: cert, psk.
    name str
    Auth-group name.
    peer str
    If peer-accept is set to one, select the name of one peer to add to this authentication group. The peer must have added with the wanopt peer command.
    peer_accept str
    Determine if this auth group accepts, any peer, a list of defined peers, or just one peer. Valid values: any, defined, one.
    psk str
    Pre-shared key used by the peers in this authentication group.
    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.
    cert String
    Name of certificate to identify this peer.
    authMethod String
    Select certificate or pre-shared key authentication for this authentication group. Valid values: cert, psk.
    name String
    Auth-group name.
    peer String
    If peer-accept is set to one, select the name of one peer to add to this authentication group. The peer must have added with the wanopt peer command.
    peerAccept String
    Determine if this auth group accepts, any peer, a list of defined peers, or just one peer. Valid values: any, defined, one.
    psk String
    Pre-shared key used by the peers in this authentication group.
    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.

    Outputs

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

    Get an existing Authgroup 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?: AuthgroupState, opts?: CustomResourceOptions): Authgroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auth_method: Optional[str] = None,
            cert: Optional[str] = None,
            name: Optional[str] = None,
            peer: Optional[str] = None,
            peer_accept: Optional[str] = None,
            psk: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Authgroup
    func GetAuthgroup(ctx *Context, name string, id IDInput, state *AuthgroupState, opts ...ResourceOption) (*Authgroup, error)
    public static Authgroup Get(string name, Input<string> id, AuthgroupState? state, CustomResourceOptions? opts = null)
    public static Authgroup get(String name, Output<String> id, AuthgroupState 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:
    AuthMethod string
    Select certificate or pre-shared key authentication for this authentication group. Valid values: cert, psk.
    Cert string
    Name of certificate to identify this peer.
    Name string
    Auth-group name.
    Peer string
    If peer-accept is set to one, select the name of one peer to add to this authentication group. The peer must have added with the wanopt peer command.
    PeerAccept string
    Determine if this auth group accepts, any peer, a list of defined peers, or just one peer. Valid values: any, defined, one.
    Psk string
    Pre-shared key used by the peers in this authentication group.
    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.
    AuthMethod string
    Select certificate or pre-shared key authentication for this authentication group. Valid values: cert, psk.
    Cert string
    Name of certificate to identify this peer.
    Name string
    Auth-group name.
    Peer string
    If peer-accept is set to one, select the name of one peer to add to this authentication group. The peer must have added with the wanopt peer command.
    PeerAccept string
    Determine if this auth group accepts, any peer, a list of defined peers, or just one peer. Valid values: any, defined, one.
    Psk string
    Pre-shared key used by the peers in this authentication group.
    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.
    authMethod String
    Select certificate or pre-shared key authentication for this authentication group. Valid values: cert, psk.
    cert String
    Name of certificate to identify this peer.
    name String
    Auth-group name.
    peer String
    If peer-accept is set to one, select the name of one peer to add to this authentication group. The peer must have added with the wanopt peer command.
    peerAccept String
    Determine if this auth group accepts, any peer, a list of defined peers, or just one peer. Valid values: any, defined, one.
    psk String
    Pre-shared key used by the peers in this authentication group.
    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.
    authMethod string
    Select certificate or pre-shared key authentication for this authentication group. Valid values: cert, psk.
    cert string
    Name of certificate to identify this peer.
    name string
    Auth-group name.
    peer string
    If peer-accept is set to one, select the name of one peer to add to this authentication group. The peer must have added with the wanopt peer command.
    peerAccept string
    Determine if this auth group accepts, any peer, a list of defined peers, or just one peer. Valid values: any, defined, one.
    psk string
    Pre-shared key used by the peers in this authentication group.
    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.
    auth_method str
    Select certificate or pre-shared key authentication for this authentication group. Valid values: cert, psk.
    cert str
    Name of certificate to identify this peer.
    name str
    Auth-group name.
    peer str
    If peer-accept is set to one, select the name of one peer to add to this authentication group. The peer must have added with the wanopt peer command.
    peer_accept str
    Determine if this auth group accepts, any peer, a list of defined peers, or just one peer. Valid values: any, defined, one.
    psk str
    Pre-shared key used by the peers in this authentication group.
    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.
    authMethod String
    Select certificate or pre-shared key authentication for this authentication group. Valid values: cert, psk.
    cert String
    Name of certificate to identify this peer.
    name String
    Auth-group name.
    peer String
    If peer-accept is set to one, select the name of one peer to add to this authentication group. The peer must have added with the wanopt peer command.
    peerAccept String
    Determine if this auth group accepts, any peer, a list of defined peers, or just one peer. Valid values: any, defined, one.
    psk String
    Pre-shared key used by the peers in this authentication group.
    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.

    Import

    Wanopt AuthGroup can be imported using any of these accepted formats:

    $ pulumi import fortios:wanopt/authgroup:Authgroup labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:wanopt/authgroup:Authgroup 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