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

fortios.firewall.ObjectVipgroup

Explore with Pulumi AI

Provides a resource to configure virtual IP groups of FortiOS.

!> Warning: The resource will be deprecated and replaced by new resource fortios.firewall.Vipgrp, we recommend that you use the new resource.

Example Usage

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

const v11 = new fortios.firewall.ObjectVipgroup("v11", {
    comments: "comments",
    "interface": "port3",
    members: [
        "vip1",
        "vip3",
    ],
});
Copy
import pulumi
import pulumiverse_fortios as fortios

v11 = fortios.firewall.ObjectVipgroup("v11",
    comments="comments",
    interface="port3",
    members=[
        "vip1",
        "vip3",
    ])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := firewall.NewObjectVipgroup(ctx, "v11", &firewall.ObjectVipgroupArgs{
			Comments:  pulumi.String("comments"),
			Interface: pulumi.String("port3"),
			Members: pulumi.StringArray{
				pulumi.String("vip1"),
				pulumi.String("vip3"),
			},
		})
		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 v11 = new Fortios.Firewall.ObjectVipgroup("v11", new()
    {
        Comments = "comments",
        Interface = "port3",
        Members = new[]
        {
            "vip1",
            "vip3",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.firewall.ObjectVipgroup;
import com.pulumi.fortios.firewall.ObjectVipgroupArgs;
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 v11 = new ObjectVipgroup("v11", ObjectVipgroupArgs.builder()
            .comments("comments")
            .interface_("port3")
            .members(            
                "vip1",
                "vip3")
            .build());

    }
}
Copy
resources:
  v11:
    type: fortios:firewall:ObjectVipgroup
    properties:
      comments: comments
      interface: port3
      members:
        - vip1
        - vip3
Copy

Create ObjectVipgroup Resource

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

Constructor syntax

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

@overload
def ObjectVipgroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   members: Optional[Sequence[str]] = None,
                   comments: Optional[str] = None,
                   interface: Optional[str] = None,
                   name: Optional[str] = None)
func NewObjectVipgroup(ctx *Context, name string, args ObjectVipgroupArgs, opts ...ResourceOption) (*ObjectVipgroup, error)
public ObjectVipgroup(string name, ObjectVipgroupArgs args, CustomResourceOptions? opts = null)
public ObjectVipgroup(String name, ObjectVipgroupArgs args)
public ObjectVipgroup(String name, ObjectVipgroupArgs args, CustomResourceOptions options)
type: fortios:firewall:ObjectVipgroup
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 This property is required. ObjectVipgroupArgs
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 This property is required. ObjectVipgroupArgs
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 This property is required. ObjectVipgroupArgs
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 This property is required. ObjectVipgroupArgs
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. ObjectVipgroupArgs
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 objectVipgroupResource = new Fortios.Firewall.ObjectVipgroup("objectVipgroupResource", new()
{
    Members = new[]
    {
        "string",
    },
    Comments = "string",
    Interface = "string",
    Name = "string",
});
Copy
example, err := firewall.NewObjectVipgroup(ctx, "objectVipgroupResource", &firewall.ObjectVipgroupArgs{
	Members: pulumi.StringArray{
		pulumi.String("string"),
	},
	Comments:  pulumi.String("string"),
	Interface: pulumi.String("string"),
	Name:      pulumi.String("string"),
})
Copy
var objectVipgroupResource = new ObjectVipgroup("objectVipgroupResource", ObjectVipgroupArgs.builder()
    .members("string")
    .comments("string")
    .interface_("string")
    .name("string")
    .build());
Copy
object_vipgroup_resource = fortios.firewall.ObjectVipgroup("objectVipgroupResource",
    members=["string"],
    comments="string",
    interface="string",
    name="string")
Copy
const objectVipgroupResource = new fortios.firewall.ObjectVipgroup("objectVipgroupResource", {
    members: ["string"],
    comments: "string",
    "interface": "string",
    name: "string",
});
Copy
type: fortios:firewall:ObjectVipgroup
properties:
    comments: string
    interface: string
    members:
        - string
    name: string
Copy

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

Members This property is required. List<string>
Member VIP objects of the group.
Comments string
Comment.
Interface string
Interface name.
Name string
VIP group name.
Members This property is required. []string
Member VIP objects of the group.
Comments string
Comment.
Interface string
Interface name.
Name string
VIP group name.
members This property is required. List<String>
Member VIP objects of the group.
comments String
Comment.
interface_ String
Interface name.
name String
VIP group name.
members This property is required. string[]
Member VIP objects of the group.
comments string
Comment.
interface string
Interface name.
name string
VIP group name.
members This property is required. Sequence[str]
Member VIP objects of the group.
comments str
Comment.
interface str
Interface name.
name str
VIP group name.
members This property is required. List<String>
Member VIP objects of the group.
comments String
Comment.
interface String
Interface name.
name String
VIP group name.

Outputs

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

Get an existing ObjectVipgroup 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?: ObjectVipgroupState, opts?: CustomResourceOptions): ObjectVipgroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comments: Optional[str] = None,
        interface: Optional[str] = None,
        members: Optional[Sequence[str]] = None,
        name: Optional[str] = None) -> ObjectVipgroup
func GetObjectVipgroup(ctx *Context, name string, id IDInput, state *ObjectVipgroupState, opts ...ResourceOption) (*ObjectVipgroup, error)
public static ObjectVipgroup Get(string name, Input<string> id, ObjectVipgroupState? state, CustomResourceOptions? opts = null)
public static ObjectVipgroup get(String name, Output<String> id, ObjectVipgroupState state, CustomResourceOptions options)
resources:  _:    type: fortios:firewall:ObjectVipgroup    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:
Comments string
Comment.
Interface string
Interface name.
Members List<string>
Member VIP objects of the group.
Name string
VIP group name.
Comments string
Comment.
Interface string
Interface name.
Members []string
Member VIP objects of the group.
Name string
VIP group name.
comments String
Comment.
interface_ String
Interface name.
members List<String>
Member VIP objects of the group.
name String
VIP group name.
comments string
Comment.
interface string
Interface name.
members string[]
Member VIP objects of the group.
name string
VIP group name.
comments str
Comment.
interface str
Interface name.
members Sequence[str]
Member VIP objects of the group.
name str
VIP group name.
comments String
Comment.
interface String
Interface name.
members List<String>
Member VIP objects of the group.
name String
VIP group name.

Package Details

Repository
fortios pulumiverse/pulumi-fortios
License
Apache-2.0
Notes
This Pulumi package is based on the fortios Terraform Provider.