1. Packages
  2. Fortios
  3. API Docs
  4. user
  5. Adgrp
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.user.Adgrp

Explore with Pulumi AI

Configure FSSO groups.

Example Usage

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

const trname1 = new fortios.user.Fsso("trname1", {
    port: 32381,
    port2: 8000,
    port3: 8000,
    port4: 8000,
    port5: 8000,
    server: "1.1.1.1",
    sourceIp: "0.0.0.0",
    sourceIp6: "::",
});
const trname = new fortios.user.Adgrp("trname", {serverName: trname1.name});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname1 = fortios.user.Fsso("trname1",
    port=32381,
    port2=8000,
    port3=8000,
    port4=8000,
    port5=8000,
    server="1.1.1.1",
    source_ip="0.0.0.0",
    source_ip6="::")
trname = fortios.user.Adgrp("trname", server_name=trname1.name)
Copy
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 {
		trname1, err := user.NewFsso(ctx, "trname1", &user.FssoArgs{
			Port:      pulumi.Int(32381),
			Port2:     pulumi.Int(8000),
			Port3:     pulumi.Int(8000),
			Port4:     pulumi.Int(8000),
			Port5:     pulumi.Int(8000),
			Server:    pulumi.String("1.1.1.1"),
			SourceIp:  pulumi.String("0.0.0.0"),
			SourceIp6: pulumi.String("::"),
		})
		if err != nil {
			return err
		}
		_, err = user.NewAdgrp(ctx, "trname", &user.AdgrpArgs{
			ServerName: trname1.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname1 = new Fortios.User.Fsso("trname1", new()
    {
        Port = 32381,
        Port2 = 8000,
        Port3 = 8000,
        Port4 = 8000,
        Port5 = 8000,
        Server = "1.1.1.1",
        SourceIp = "0.0.0.0",
        SourceIp6 = "::",
    });

    var trname = new Fortios.User.Adgrp("trname", new()
    {
        ServerName = trname1.Name,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.user.Fsso;
import com.pulumi.fortios.user.FssoArgs;
import com.pulumi.fortios.user.Adgrp;
import com.pulumi.fortios.user.AdgrpArgs;
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 trname1 = new Fsso("trname1", FssoArgs.builder()
            .port(32381)
            .port2(8000)
            .port3(8000)
            .port4(8000)
            .port5(8000)
            .server("1.1.1.1")
            .sourceIp("0.0.0.0")
            .sourceIp6("::")
            .build());

        var trname = new Adgrp("trname", AdgrpArgs.builder()
            .serverName(trname1.name())
            .build());

    }
}
Copy
resources:
  trname1:
    type: fortios:user:Fsso
    properties:
      port: 32381
      port2: 8000
      port3: 8000
      port4: 8000
      port5: 8000
      server: 1.1.1.1
      sourceIp: 0.0.0.0
      sourceIp6: '::'
  trname:
    type: fortios:user:Adgrp
    properties:
      serverName: ${trname1.name}
Copy

Create Adgrp Resource

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

Constructor syntax

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

@overload
def Adgrp(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          connector_source: Optional[str] = None,
          fosid: Optional[int] = None,
          name: Optional[str] = None,
          server_name: Optional[str] = None,
          vdomparam: Optional[str] = None)
func NewAdgrp(ctx *Context, name string, args *AdgrpArgs, opts ...ResourceOption) (*Adgrp, error)
public Adgrp(string name, AdgrpArgs? args = null, CustomResourceOptions? opts = null)
public Adgrp(String name, AdgrpArgs args)
public Adgrp(String name, AdgrpArgs args, CustomResourceOptions options)
type: fortios:user:Adgrp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args AdgrpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args AdgrpArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args AdgrpArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args AdgrpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AdgrpArgs
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 adgrpResource = new Fortios.User.Adgrp("adgrpResource", new()
{
    ConnectorSource = "string",
    Fosid = 0,
    Name = "string",
    ServerName = "string",
    Vdomparam = "string",
});
Copy
example, err := user.NewAdgrp(ctx, "adgrpResource", &user.AdgrpArgs{
	ConnectorSource: pulumi.String("string"),
	Fosid:           pulumi.Int(0),
	Name:            pulumi.String("string"),
	ServerName:      pulumi.String("string"),
	Vdomparam:       pulumi.String("string"),
})
Copy
var adgrpResource = new Adgrp("adgrpResource", AdgrpArgs.builder()
    .connectorSource("string")
    .fosid(0)
    .name("string")
    .serverName("string")
    .vdomparam("string")
    .build());
Copy
adgrp_resource = fortios.user.Adgrp("adgrpResource",
    connector_source="string",
    fosid=0,
    name="string",
    server_name="string",
    vdomparam="string")
Copy
const adgrpResource = new fortios.user.Adgrp("adgrpResource", {
    connectorSource: "string",
    fosid: 0,
    name: "string",
    serverName: "string",
    vdomparam: "string",
});
Copy
type: fortios:user:Adgrp
properties:
    connectorSource: string
    fosid: 0
    name: string
    serverName: string
    vdomparam: string
Copy

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

ConnectorSource string
FSSO connector source.
Fosid int
Group ID.
Name Changes to this property will trigger replacement. string
Name.
ServerName string
FSSO agent name.
Vdomparam Changes to this property will trigger replacement. 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.
ConnectorSource string
FSSO connector source.
Fosid int
Group ID.
Name Changes to this property will trigger replacement. string
Name.
ServerName string
FSSO agent name.
Vdomparam Changes to this property will trigger replacement. 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.
connectorSource String
FSSO connector source.
fosid Integer
Group ID.
name Changes to this property will trigger replacement. String
Name.
serverName String
FSSO agent name.
vdomparam Changes to this property will trigger replacement. 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.
connectorSource string
FSSO connector source.
fosid number
Group ID.
name Changes to this property will trigger replacement. string
Name.
serverName string
FSSO agent name.
vdomparam Changes to this property will trigger replacement. 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.
connector_source str
FSSO connector source.
fosid int
Group ID.
name Changes to this property will trigger replacement. str
Name.
server_name str
FSSO agent name.
vdomparam Changes to this property will trigger replacement. 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.
connectorSource String
FSSO connector source.
fosid Number
Group ID.
name Changes to this property will trigger replacement. String
Name.
serverName String
FSSO agent name.
vdomparam Changes to this property will trigger replacement. 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 Adgrp 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 Adgrp Resource

Get an existing Adgrp 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?: AdgrpState, opts?: CustomResourceOptions): Adgrp
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connector_source: Optional[str] = None,
        fosid: Optional[int] = None,
        name: Optional[str] = None,
        server_name: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Adgrp
func GetAdgrp(ctx *Context, name string, id IDInput, state *AdgrpState, opts ...ResourceOption) (*Adgrp, error)
public static Adgrp Get(string name, Input<string> id, AdgrpState? state, CustomResourceOptions? opts = null)
public static Adgrp get(String name, Output<String> id, AdgrpState state, CustomResourceOptions options)
resources:  _:    type: fortios:user:Adgrp    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ConnectorSource string
FSSO connector source.
Fosid int
Group ID.
Name Changes to this property will trigger replacement. string
Name.
ServerName string
FSSO agent name.
Vdomparam Changes to this property will trigger replacement. 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.
ConnectorSource string
FSSO connector source.
Fosid int
Group ID.
Name Changes to this property will trigger replacement. string
Name.
ServerName string
FSSO agent name.
Vdomparam Changes to this property will trigger replacement. 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.
connectorSource String
FSSO connector source.
fosid Integer
Group ID.
name Changes to this property will trigger replacement. String
Name.
serverName String
FSSO agent name.
vdomparam Changes to this property will trigger replacement. 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.
connectorSource string
FSSO connector source.
fosid number
Group ID.
name Changes to this property will trigger replacement. string
Name.
serverName string
FSSO agent name.
vdomparam Changes to this property will trigger replacement. 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.
connector_source str
FSSO connector source.
fosid int
Group ID.
name Changes to this property will trigger replacement. str
Name.
server_name str
FSSO agent name.
vdomparam Changes to this property will trigger replacement. 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.
connectorSource String
FSSO connector source.
fosid Number
Group ID.
name Changes to this property will trigger replacement. String
Name.
serverName String
FSSO agent name.
vdomparam Changes to this property will trigger replacement. 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

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

$ pulumi import fortios:user/adgrp:Adgrp labelname {{name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:user/adgrp:Adgrp labelname {{name}}
Copy

$ 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.