Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. user
  5. Peergrp
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.user.Peergrp

Explore with Pulumi AI

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

    Configure peer groups.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname2 = new fortios.user.Peer("trname2", {
    ca: "EC-ACC",
    cnType: "string",
    ldapMode: "password",
    mandatoryCaVerify: "enable",
    twoFactor: "disable",
});
const trname = new fortios.user.Peergrp("trname", {members: [{
    name: trname2.name,
}]});

    import pulumi
import pulumiverse_fortios as fortios

trname2 = fortios.user.Peer("trname2",
    ca="EC-ACC",
    cn_type="string",
    ldap_mode="password",
    mandatory_ca_verify="enable",
    two_factor="disable")
trname = fortios.user.Peergrp("trname", members=[fortios.user.PeergrpMemberArgs(
    name=trname2.name,
)])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/user"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		trname2, err := user.NewPeer(ctx, "trname2", &user.PeerArgs{
			Ca:                pulumi.String("EC-ACC"),
			CnType:            pulumi.String("string"),
			LdapMode:          pulumi.String("password"),
			MandatoryCaVerify: pulumi.String("enable"),
			TwoFactor:         pulumi.String("disable"),
		})
		if err != nil {
			return err
		}
		_, err = user.NewPeergrp(ctx, "trname", &user.PeergrpArgs{
			Members: user.PeergrpMemberArray{
				&user.PeergrpMemberArgs{
					Name: trname2.Name,
				},
			},
		})
		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 trname2 = new Fortios.User.Peer("trname2", new()
    {
        Ca = "EC-ACC",
        CnType = "string",
        LdapMode = "password",
        MandatoryCaVerify = "enable",
        TwoFactor = "disable",
    });

    var trname = new Fortios.User.Peergrp("trname", new()
    {
        Members = new[]
        {
            new Fortios.User.Inputs.PeergrpMemberArgs
            {
                Name = trname2.Name,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.user.Peer;
import com.pulumi.fortios.user.PeerArgs;
import com.pulumi.fortios.user.Peergrp;
import com.pulumi.fortios.user.PeergrpArgs;
import com.pulumi.fortios.user.inputs.PeergrpMemberArgs;
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 trname2 = new Peer("trname2", PeerArgs.builder()
            .ca("EC-ACC")
            .cnType("string")
            .ldapMode("password")
            .mandatoryCaVerify("enable")
            .twoFactor("disable")
            .build());

        var trname = new Peergrp("trname", PeergrpArgs.builder()
            .members(PeergrpMemberArgs.builder()
                .name(trname2.name())
                .build())
            .build());

    }
}

    resources:
  trname2:
    type: fortios:user:Peer
    properties:
      ca: EC-ACC
      cnType: string
      ldapMode: password
      mandatoryCaVerify: enable
      twoFactor: disable
  trname:
    type: fortios:user:Peergrp
    properties:
      members:
        - name: ${trname2.name}

    Create Peergrp Resource

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

    Constructor syntax

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

@overload
def Peergrp(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            dynamic_sort_subtable: Optional[str] = None,
            get_all_tables: Optional[str] = None,
            members: Optional[Sequence[PeergrpMemberArgs]] = None,
            name: Optional[str] = None,
            vdomparam: Optional[str] = None)
    func NewPeergrp(ctx *Context, name string, args *PeergrpArgs, opts ...ResourceOption) (*Peergrp, error)
    public Peergrp(string name, PeergrpArgs? args = null, CustomResourceOptions? opts = null)
    public Peergrp(String name, PeergrpArgs args)
public Peergrp(String name, PeergrpArgs args, CustomResourceOptions options)

    type: fortios:user:Peergrp
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 PeergrpArgs
    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 PeergrpArgs
    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 PeergrpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PeergrpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PeergrpArgs
    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 peergrpResource = new Fortios.User.Peergrp("peergrpResource", new()
{
    DynamicSortSubtable = "string",
    GetAllTables = "string",
    Members = new[]
    {
        new Fortios.User.Inputs.PeergrpMemberArgs
        {
            Name = "string",
        },
    },
    Name = "string",
    Vdomparam = "string",
});

    example, err := user.NewPeergrp(ctx, "peergrpResource", &user.PeergrpArgs{
	DynamicSortSubtable: pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	Members: user.PeergrpMemberArray{
		&user.PeergrpMemberArgs{
			Name: pulumi.String("string"),
		},
	},
	Name:      pulumi.String("string"),
	Vdomparam: pulumi.String("string"),
})

    var peergrpResource = new Peergrp("peergrpResource", PeergrpArgs.builder()
    .dynamicSortSubtable("string")
    .getAllTables("string")
    .members(PeergrpMemberArgs.builder()
        .name("string")
        .build())
    .name("string")
    .vdomparam("string")
    .build());

    peergrp_resource = fortios.user.Peergrp("peergrpResource",
    dynamic_sort_subtable="string",
    get_all_tables="string",
    members=[{
        "name": "string",
    }],
    name="string",
    vdomparam="string")

    const peergrpResource = new fortios.user.Peergrp("peergrpResource", {
    dynamicSortSubtable: "string",
    getAllTables: "string",
    members: [{
        name: "string",
    }],
    name: "string",
    vdomparam: "string",
});

    type: fortios:user:Peergrp
properties:
    dynamicSortSubtable: string
    getAllTables: string
    members:
        - name: string
    name: string
    vdomparam: string

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

    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Members List<Pulumiverse.Fortios.User.Inputs.PeergrpMember>
    Peer group members. The structure of member block is documented below.
    Name string
    Peer group name.
    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.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Members []PeergrpMemberArgs
    Peer group members. The structure of member block is documented below.
    Name string
    Peer group name.
    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.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    members List<PeergrpMember>
    Peer group members. The structure of member block is documented below.
    name String
    Peer group name.
    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.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    members PeergrpMember[]
    Peer group members. The structure of member block is documented below.
    name string
    Peer group name.
    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.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    members Sequence[PeergrpMemberArgs]
    Peer group members. The structure of member block is documented below.
    name str
    Peer group name.
    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.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    members List<Property Map>
    Peer group members. The structure of member block is documented below.
    name String
    Peer group name.
    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 Peergrp 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 Peergrp Resource

    Get an existing Peergrp 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?: PeergrpState, opts?: CustomResourceOptions): Peergrp
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        members: Optional[Sequence[PeergrpMemberArgs]] = None,
        name: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Peergrp
    func GetPeergrp(ctx *Context, name string, id IDInput, state *PeergrpState, opts ...ResourceOption) (*Peergrp, error)
    public static Peergrp Get(string name, Input<string> id, PeergrpState? state, CustomResourceOptions? opts = null)
    public static Peergrp get(String name, Output<String> id, PeergrpState 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:
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Members List<Pulumiverse.Fortios.User.Inputs.PeergrpMember>
    Peer group members. The structure of member block is documented below.
    Name string
    Peer group name.
    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.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Members []PeergrpMemberArgs
    Peer group members. The structure of member block is documented below.
    Name string
    Peer group name.
    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.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    members List<PeergrpMember>
    Peer group members. The structure of member block is documented below.
    name String
    Peer group name.
    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.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    members PeergrpMember[]
    Peer group members. The structure of member block is documented below.
    name string
    Peer group name.
    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.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    members Sequence[PeergrpMemberArgs]
    Peer group members. The structure of member block is documented below.
    name str
    Peer group name.
    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.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    members List<Property Map>
    Peer group members. The structure of member block is documented below.
    name String
    Peer group name.
    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.

    Supporting Types

    PeergrpMember, PeergrpMemberArgs

    Name string
    Peer group member name.
    Name string
    Peer group member name.
    name String
    Peer group member name.
    name string
    Peer group member name.
    name str
    Peer group member name.
    name String
    Peer group member name.

    Import

    User Peergrp can be imported using any of these accepted formats:

    $ pulumi import fortios:user/peergrp:Peergrp labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:user/peergrp:Peergrp 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.6 published on Tuesday, Jul 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios