Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. SystemSnmpCommunity
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.SystemSnmpCommunity

Explore with Pulumi AI

fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

SNMP community configuration.

The following variables have sub resource. Avoid using them together, otherwise conflicts and overwrites may occur.

  • hosts: fortimanager.SystemSnmpCommunityHosts
  • hosts6: fortimanager.SystemSnmpCommunityHosts6

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortimanager from "@pulumi/fortimanager";

const trname = new fortimanager.SystemSnmpCommunity("trname", {
    events: ["cpu-high-exclude-nice"],
    fosid: 1,
    status: "disable",
});
Copy
import pulumi
import pulumi_fortimanager as fortimanager

trname = fortimanager.SystemSnmpCommunity("trname",
    events=["cpu-high-exclude-nice"],
    fosid=1,
    status="disable")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fortimanager/fortimanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fortimanager.NewSystemSnmpCommunity(ctx, "trname", &fortimanager.SystemSnmpCommunityArgs{
			Events: pulumi.StringArray{
				pulumi.String("cpu-high-exclude-nice"),
			},
			Fosid:  pulumi.Float64(1),
			Status: pulumi.String("disable"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortimanager = Pulumi.Fortimanager;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortimanager.SystemSnmpCommunity("trname", new()
    {
        Events = new[]
        {
            "cpu-high-exclude-nice",
        },
        Fosid = 1,
        Status = "disable",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.SystemSnmpCommunity;
import com.pulumi.fortimanager.SystemSnmpCommunityArgs;
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 SystemSnmpCommunity("trname", SystemSnmpCommunityArgs.builder()
            .events("cpu-high-exclude-nice")
            .fosid("1")
            .status("disable")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortimanager:SystemSnmpCommunity
    properties:
      events:
        - cpu-high-exclude-nice
      fosid: '1'
      status: disable
Copy

Create SystemSnmpCommunity Resource

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

Constructor syntax

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

@overload
def SystemSnmpCommunity(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        dynamic_sort_subtable: Optional[str] = None,
                        events: Optional[Sequence[str]] = None,
                        fosid: Optional[float] = None,
                        hosts: Optional[Sequence[SystemSnmpCommunityHostArgs]] = None,
                        hosts6s: Optional[Sequence[SystemSnmpCommunityHosts6Args]] = None,
                        name: Optional[str] = None,
                        query_v1_port: Optional[float] = None,
                        query_v1_status: Optional[str] = None,
                        query_v2c_port: Optional[float] = None,
                        query_v2c_status: Optional[str] = None,
                        status: Optional[str] = None,
                        system_snmp_community_id: Optional[str] = None,
                        trap_v1_rport: Optional[float] = None,
                        trap_v1_status: Optional[str] = None,
                        trap_v2c_rport: Optional[float] = None,
                        trap_v2c_status: Optional[str] = None)
func NewSystemSnmpCommunity(ctx *Context, name string, args *SystemSnmpCommunityArgs, opts ...ResourceOption) (*SystemSnmpCommunity, error)
public SystemSnmpCommunity(string name, SystemSnmpCommunityArgs? args = null, CustomResourceOptions? opts = null)
public SystemSnmpCommunity(String name, SystemSnmpCommunityArgs args)
public SystemSnmpCommunity(String name, SystemSnmpCommunityArgs args, CustomResourceOptions options)

type: fortimanager:SystemSnmpCommunity
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 SystemSnmpCommunityArgs
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 SystemSnmpCommunityArgs
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 SystemSnmpCommunityArgs
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 SystemSnmpCommunityArgs
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. SystemSnmpCommunityArgs
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 systemSnmpCommunityResource = new Fortimanager.SystemSnmpCommunity("systemSnmpCommunityResource", new()
{
    DynamicSortSubtable = "string",
    Events = new[]
    {
        "string",
    },
    Fosid = 0,
    Hosts = new[]
    {
        new Fortimanager.Inputs.SystemSnmpCommunityHostArgs
        {
            Id = 0,
            Interface = "string",
            Ip = "string",
        },
    },
    Hosts6s = new[]
    {
        new Fortimanager.Inputs.SystemSnmpCommunityHosts6Args
        {
            Id = 0,
            Interface = "string",
            Ip = "string",
        },
    },
    Name = "string",
    QueryV1Port = 0,
    QueryV1Status = "string",
    QueryV2cPort = 0,
    QueryV2cStatus = "string",
    Status = "string",
    SystemSnmpCommunityId = "string",
    TrapV1Rport = 0,
    TrapV1Status = "string",
    TrapV2cRport = 0,
    TrapV2cStatus = "string",
});
Copy
example, err := fortimanager.NewSystemSnmpCommunity(ctx, "systemSnmpCommunityResource", &fortimanager.SystemSnmpCommunityArgs{
DynamicSortSubtable: pulumi.String("string"),
Events: pulumi.StringArray{
pulumi.String("string"),
},
Fosid: pulumi.Float64(0),
Hosts: .SystemSnmpCommunityHostArray{
&.SystemSnmpCommunityHostArgs{
Id: pulumi.Float64(0),
Interface: pulumi.String("string"),
Ip: pulumi.String("string"),
},
},
Hosts6s: .SystemSnmpCommunityHosts6TypeArray{
&.SystemSnmpCommunityHosts6TypeArgs{
Id: pulumi.Float64(0),
Interface: pulumi.String("string"),
Ip: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
QueryV1Port: pulumi.Float64(0),
QueryV1Status: pulumi.String("string"),
QueryV2cPort: pulumi.Float64(0),
QueryV2cStatus: pulumi.String("string"),
Status: pulumi.String("string"),
SystemSnmpCommunityId: pulumi.String("string"),
TrapV1Rport: pulumi.Float64(0),
TrapV1Status: pulumi.String("string"),
TrapV2cRport: pulumi.Float64(0),
TrapV2cStatus: pulumi.String("string"),
})
Copy
var systemSnmpCommunityResource = new SystemSnmpCommunity("systemSnmpCommunityResource", SystemSnmpCommunityArgs.builder()
    .dynamicSortSubtable("string")
    .events("string")
    .fosid(0)
    .hosts(SystemSnmpCommunityHostArgs.builder()
        .id(0)
        .interface_("string")
        .ip("string")
        .build())
    .hosts6s(SystemSnmpCommunityHosts6Args.builder()
        .id(0)
        .interface_("string")
        .ip("string")
        .build())
    .name("string")
    .queryV1Port(0)
    .queryV1Status("string")
    .queryV2cPort(0)
    .queryV2cStatus("string")
    .status("string")
    .systemSnmpCommunityId("string")
    .trapV1Rport(0)
    .trapV1Status("string")
    .trapV2cRport(0)
    .trapV2cStatus("string")
    .build());
Copy
system_snmp_community_resource = fortimanager.SystemSnmpCommunity("systemSnmpCommunityResource",
    dynamic_sort_subtable="string",
    events=["string"],
    fosid=0,
    hosts=[{
        "id": 0,
        "interface": "string",
        "ip": "string",
    }],
    hosts6s=[{
        "id": 0,
        "interface": "string",
        "ip": "string",
    }],
    name="string",
    query_v1_port=0,
    query_v1_status="string",
    query_v2c_port=0,
    query_v2c_status="string",
    status="string",
    system_snmp_community_id="string",
    trap_v1_rport=0,
    trap_v1_status="string",
    trap_v2c_rport=0,
    trap_v2c_status="string")
Copy
const systemSnmpCommunityResource = new fortimanager.SystemSnmpCommunity("systemSnmpCommunityResource", {
    dynamicSortSubtable: "string",
    events: ["string"],
    fosid: 0,
    hosts: [{
        id: 0,
        "interface": "string",
        ip: "string",
    }],
    hosts6s: [{
        id: 0,
        "interface": "string",
        ip: "string",
    }],
    name: "string",
    queryV1Port: 0,
    queryV1Status: "string",
    queryV2cPort: 0,
    queryV2cStatus: "string",
    status: "string",
    systemSnmpCommunityId: "string",
    trapV1Rport: 0,
    trapV1Status: "string",
    trapV2cRport: 0,
    trapV2cStatus: "string",
});
Copy
type: fortimanager:SystemSnmpCommunity
properties:
    dynamicSortSubtable: string
    events:
        - string
    fosid: 0
    hosts:
        - id: 0
          interface: string
          ip: string
    hosts6s:
        - id: 0
          interface: string
          ip: string
    name: string
    queryV1Port: 0
    queryV1Status: string
    queryV2cPort: 0
    queryV2cStatus: string
    status: string
    systemSnmpCommunityId: string
    trapV1Rport: 0
    trapV1Status: string
    trapV2cRport: 0
    trapV2cStatus: string
Copy

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

DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Events List<string>
SNMP trap events. disk_low - Disk usage too high. ha_switch - HA switch. intf_ip_chg - Interface IP address changed. sys_reboot - System reboot. cpu_high - CPU usage too high. mem_low - Available memory is low. log-alert - Log base alert message. log-rate - High incoming log rate detected. log-data-rate - High incoming log data rate detected. lic-gbday - High licensed log GB/day detected. lic-dev-quota - High licensed device quota detected. cpu-high-exclude-nice - CPU usage exclude NICE threshold. Valid values: disk_low, ha_switch, intf_ip_chg, sys_reboot, cpu_high, mem_low, log-alert, log-rate, log-data-rate, lic-gbday, lic-dev-quota, cpu-high-exclude-nice.
Fosid double
Community ID.
Hosts List<SystemSnmpCommunityHost>
Hosts. The structure of hosts block is documented below.
Hosts6s List<SystemSnmpCommunityHosts6>
Hosts6. The structure of hosts6 block is documented below.
Name string
Community name.
QueryV1Port double
SNMP v1 query port.
QueryV1Status string
Enable/disable SNMP v1 query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
QueryV2cPort double
SNMP v2c query port.
QueryV2cStatus string
Enable/disable SNMP v2c query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
Status string
Enable/disable community. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
SystemSnmpCommunityId string
an identifier for the resource with format {{fosid}}.
TrapV1Rport double
SNMP v1 trap remote port.
TrapV1Status string
Enable/disable SNMP v1 trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
TrapV2cRport double
SNMP v2c trap remote port.
TrapV2cStatus string
Enable/disable SNMP v2c trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Events []string
SNMP trap events. disk_low - Disk usage too high. ha_switch - HA switch. intf_ip_chg - Interface IP address changed. sys_reboot - System reboot. cpu_high - CPU usage too high. mem_low - Available memory is low. log-alert - Log base alert message. log-rate - High incoming log rate detected. log-data-rate - High incoming log data rate detected. lic-gbday - High licensed log GB/day detected. lic-dev-quota - High licensed device quota detected. cpu-high-exclude-nice - CPU usage exclude NICE threshold. Valid values: disk_low, ha_switch, intf_ip_chg, sys_reboot, cpu_high, mem_low, log-alert, log-rate, log-data-rate, lic-gbday, lic-dev-quota, cpu-high-exclude-nice.
Fosid float64
Community ID.
Hosts []SystemSnmpCommunityHostArgs
Hosts. The structure of hosts block is documented below.
Hosts6s []SystemSnmpCommunityHosts6TypeArgs
Hosts6. The structure of hosts6 block is documented below.
Name string
Community name.
QueryV1Port float64
SNMP v1 query port.
QueryV1Status string
Enable/disable SNMP v1 query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
QueryV2cPort float64
SNMP v2c query port.
QueryV2cStatus string
Enable/disable SNMP v2c query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
Status string
Enable/disable community. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
SystemSnmpCommunityId string
an identifier for the resource with format {{fosid}}.
TrapV1Rport float64
SNMP v1 trap remote port.
TrapV1Status string
Enable/disable SNMP v1 trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
TrapV2cRport float64
SNMP v2c trap remote port.
TrapV2cStatus string
Enable/disable SNMP v2c trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
events List<String>
SNMP trap events. disk_low - Disk usage too high. ha_switch - HA switch. intf_ip_chg - Interface IP address changed. sys_reboot - System reboot. cpu_high - CPU usage too high. mem_low - Available memory is low. log-alert - Log base alert message. log-rate - High incoming log rate detected. log-data-rate - High incoming log data rate detected. lic-gbday - High licensed log GB/day detected. lic-dev-quota - High licensed device quota detected. cpu-high-exclude-nice - CPU usage exclude NICE threshold. Valid values: disk_low, ha_switch, intf_ip_chg, sys_reboot, cpu_high, mem_low, log-alert, log-rate, log-data-rate, lic-gbday, lic-dev-quota, cpu-high-exclude-nice.
fosid Double
Community ID.
hosts List<SystemSnmpCommunityHost>
Hosts. The structure of hosts block is documented below.
hosts6s List<SystemSnmpCommunityHosts6>
Hosts6. The structure of hosts6 block is documented below.
name String
Community name.
queryV1Port Double
SNMP v1 query port.
queryV1Status String
Enable/disable SNMP v1 query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
queryV2cPort Double
SNMP v2c query port.
queryV2cStatus String
Enable/disable SNMP v2c query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
status String
Enable/disable community. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
systemSnmpCommunityId String
an identifier for the resource with format {{fosid}}.
trapV1Rport Double
SNMP v1 trap remote port.
trapV1Status String
Enable/disable SNMP v1 trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
trapV2cRport Double
SNMP v2c trap remote port.
trapV2cStatus String
Enable/disable SNMP v2c trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
events string[]
SNMP trap events. disk_low - Disk usage too high. ha_switch - HA switch. intf_ip_chg - Interface IP address changed. sys_reboot - System reboot. cpu_high - CPU usage too high. mem_low - Available memory is low. log-alert - Log base alert message. log-rate - High incoming log rate detected. log-data-rate - High incoming log data rate detected. lic-gbday - High licensed log GB/day detected. lic-dev-quota - High licensed device quota detected. cpu-high-exclude-nice - CPU usage exclude NICE threshold. Valid values: disk_low, ha_switch, intf_ip_chg, sys_reboot, cpu_high, mem_low, log-alert, log-rate, log-data-rate, lic-gbday, lic-dev-quota, cpu-high-exclude-nice.
fosid number
Community ID.
hosts SystemSnmpCommunityHost[]
Hosts. The structure of hosts block is documented below.
hosts6s SystemSnmpCommunityHosts6[]
Hosts6. The structure of hosts6 block is documented below.
name string
Community name.
queryV1Port number
SNMP v1 query port.
queryV1Status string
Enable/disable SNMP v1 query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
queryV2cPort number
SNMP v2c query port.
queryV2cStatus string
Enable/disable SNMP v2c query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
status string
Enable/disable community. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
systemSnmpCommunityId string
an identifier for the resource with format {{fosid}}.
trapV1Rport number
SNMP v1 trap remote port.
trapV1Status string
Enable/disable SNMP v1 trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
trapV2cRport number
SNMP v2c trap remote port.
trapV2cStatus string
Enable/disable SNMP v2c trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
events Sequence[str]
SNMP trap events. disk_low - Disk usage too high. ha_switch - HA switch. intf_ip_chg - Interface IP address changed. sys_reboot - System reboot. cpu_high - CPU usage too high. mem_low - Available memory is low. log-alert - Log base alert message. log-rate - High incoming log rate detected. log-data-rate - High incoming log data rate detected. lic-gbday - High licensed log GB/day detected. lic-dev-quota - High licensed device quota detected. cpu-high-exclude-nice - CPU usage exclude NICE threshold. Valid values: disk_low, ha_switch, intf_ip_chg, sys_reboot, cpu_high, mem_low, log-alert, log-rate, log-data-rate, lic-gbday, lic-dev-quota, cpu-high-exclude-nice.
fosid float
Community ID.
hosts Sequence[SystemSnmpCommunityHostArgs]
Hosts. The structure of hosts block is documented below.
hosts6s Sequence[SystemSnmpCommunityHosts6Args]
Hosts6. The structure of hosts6 block is documented below.
name str
Community name.
query_v1_port float
SNMP v1 query port.
query_v1_status str
Enable/disable SNMP v1 query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
query_v2c_port float
SNMP v2c query port.
query_v2c_status str
Enable/disable SNMP v2c query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
status str
Enable/disable community. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
system_snmp_community_id str
an identifier for the resource with format {{fosid}}.
trap_v1_rport float
SNMP v1 trap remote port.
trap_v1_status str
Enable/disable SNMP v1 trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
trap_v2c_rport float
SNMP v2c trap remote port.
trap_v2c_status str
Enable/disable SNMP v2c trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
events List<String>
SNMP trap events. disk_low - Disk usage too high. ha_switch - HA switch. intf_ip_chg - Interface IP address changed. sys_reboot - System reboot. cpu_high - CPU usage too high. mem_low - Available memory is low. log-alert - Log base alert message. log-rate - High incoming log rate detected. log-data-rate - High incoming log data rate detected. lic-gbday - High licensed log GB/day detected. lic-dev-quota - High licensed device quota detected. cpu-high-exclude-nice - CPU usage exclude NICE threshold. Valid values: disk_low, ha_switch, intf_ip_chg, sys_reboot, cpu_high, mem_low, log-alert, log-rate, log-data-rate, lic-gbday, lic-dev-quota, cpu-high-exclude-nice.
fosid Number
Community ID.
hosts List<Property Map>
Hosts. The structure of hosts block is documented below.
hosts6s List<Property Map>
Hosts6. The structure of hosts6 block is documented below.
name String
Community name.
queryV1Port Number
SNMP v1 query port.
queryV1Status String
Enable/disable SNMP v1 query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
queryV2cPort Number
SNMP v2c query port.
queryV2cStatus String
Enable/disable SNMP v2c query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
status String
Enable/disable community. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
systemSnmpCommunityId String
an identifier for the resource with format {{fosid}}.
trapV1Rport Number
SNMP v1 trap remote port.
trapV1Status String
Enable/disable SNMP v1 trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
trapV2cRport Number
SNMP v2c trap remote port.
trapV2cStatus String
Enable/disable SNMP v2c trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.

Outputs

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

Get an existing SystemSnmpCommunity 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?: SystemSnmpCommunityState, opts?: CustomResourceOptions): SystemSnmpCommunity
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dynamic_sort_subtable: Optional[str] = None,
        events: Optional[Sequence[str]] = None,
        fosid: Optional[float] = None,
        hosts: Optional[Sequence[SystemSnmpCommunityHostArgs]] = None,
        hosts6s: Optional[Sequence[SystemSnmpCommunityHosts6Args]] = None,
        name: Optional[str] = None,
        query_v1_port: Optional[float] = None,
        query_v1_status: Optional[str] = None,
        query_v2c_port: Optional[float] = None,
        query_v2c_status: Optional[str] = None,
        status: Optional[str] = None,
        system_snmp_community_id: Optional[str] = None,
        trap_v1_rport: Optional[float] = None,
        trap_v1_status: Optional[str] = None,
        trap_v2c_rport: Optional[float] = None,
        trap_v2c_status: Optional[str] = None) -> SystemSnmpCommunity
func GetSystemSnmpCommunity(ctx *Context, name string, id IDInput, state *SystemSnmpCommunityState, opts ...ResourceOption) (*SystemSnmpCommunity, error)
public static SystemSnmpCommunity Get(string name, Input<string> id, SystemSnmpCommunityState? state, CustomResourceOptions? opts = null)
public static SystemSnmpCommunity get(String name, Output<String> id, SystemSnmpCommunityState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:SystemSnmpCommunity    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:
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Events List<string>
SNMP trap events. disk_low - Disk usage too high. ha_switch - HA switch. intf_ip_chg - Interface IP address changed. sys_reboot - System reboot. cpu_high - CPU usage too high. mem_low - Available memory is low. log-alert - Log base alert message. log-rate - High incoming log rate detected. log-data-rate - High incoming log data rate detected. lic-gbday - High licensed log GB/day detected. lic-dev-quota - High licensed device quota detected. cpu-high-exclude-nice - CPU usage exclude NICE threshold. Valid values: disk_low, ha_switch, intf_ip_chg, sys_reboot, cpu_high, mem_low, log-alert, log-rate, log-data-rate, lic-gbday, lic-dev-quota, cpu-high-exclude-nice.
Fosid double
Community ID.
Hosts List<SystemSnmpCommunityHost>
Hosts. The structure of hosts block is documented below.
Hosts6s List<SystemSnmpCommunityHosts6>
Hosts6. The structure of hosts6 block is documented below.
Name string
Community name.
QueryV1Port double
SNMP v1 query port.
QueryV1Status string
Enable/disable SNMP v1 query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
QueryV2cPort double
SNMP v2c query port.
QueryV2cStatus string
Enable/disable SNMP v2c query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
Status string
Enable/disable community. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
SystemSnmpCommunityId string
an identifier for the resource with format {{fosid}}.
TrapV1Rport double
SNMP v1 trap remote port.
TrapV1Status string
Enable/disable SNMP v1 trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
TrapV2cRport double
SNMP v2c trap remote port.
TrapV2cStatus string
Enable/disable SNMP v2c trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Events []string
SNMP trap events. disk_low - Disk usage too high. ha_switch - HA switch. intf_ip_chg - Interface IP address changed. sys_reboot - System reboot. cpu_high - CPU usage too high. mem_low - Available memory is low. log-alert - Log base alert message. log-rate - High incoming log rate detected. log-data-rate - High incoming log data rate detected. lic-gbday - High licensed log GB/day detected. lic-dev-quota - High licensed device quota detected. cpu-high-exclude-nice - CPU usage exclude NICE threshold. Valid values: disk_low, ha_switch, intf_ip_chg, sys_reboot, cpu_high, mem_low, log-alert, log-rate, log-data-rate, lic-gbday, lic-dev-quota, cpu-high-exclude-nice.
Fosid float64
Community ID.
Hosts []SystemSnmpCommunityHostArgs
Hosts. The structure of hosts block is documented below.
Hosts6s []SystemSnmpCommunityHosts6TypeArgs
Hosts6. The structure of hosts6 block is documented below.
Name string
Community name.
QueryV1Port float64
SNMP v1 query port.
QueryV1Status string
Enable/disable SNMP v1 query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
QueryV2cPort float64
SNMP v2c query port.
QueryV2cStatus string
Enable/disable SNMP v2c query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
Status string
Enable/disable community. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
SystemSnmpCommunityId string
an identifier for the resource with format {{fosid}}.
TrapV1Rport float64
SNMP v1 trap remote port.
TrapV1Status string
Enable/disable SNMP v1 trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
TrapV2cRport float64
SNMP v2c trap remote port.
TrapV2cStatus string
Enable/disable SNMP v2c trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
events List<String>
SNMP trap events. disk_low - Disk usage too high. ha_switch - HA switch. intf_ip_chg - Interface IP address changed. sys_reboot - System reboot. cpu_high - CPU usage too high. mem_low - Available memory is low. log-alert - Log base alert message. log-rate - High incoming log rate detected. log-data-rate - High incoming log data rate detected. lic-gbday - High licensed log GB/day detected. lic-dev-quota - High licensed device quota detected. cpu-high-exclude-nice - CPU usage exclude NICE threshold. Valid values: disk_low, ha_switch, intf_ip_chg, sys_reboot, cpu_high, mem_low, log-alert, log-rate, log-data-rate, lic-gbday, lic-dev-quota, cpu-high-exclude-nice.
fosid Double
Community ID.
hosts List<SystemSnmpCommunityHost>
Hosts. The structure of hosts block is documented below.
hosts6s List<SystemSnmpCommunityHosts6>
Hosts6. The structure of hosts6 block is documented below.
name String
Community name.
queryV1Port Double
SNMP v1 query port.
queryV1Status String
Enable/disable SNMP v1 query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
queryV2cPort Double
SNMP v2c query port.
queryV2cStatus String
Enable/disable SNMP v2c query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
status String
Enable/disable community. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
systemSnmpCommunityId String
an identifier for the resource with format {{fosid}}.
trapV1Rport Double
SNMP v1 trap remote port.
trapV1Status String
Enable/disable SNMP v1 trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
trapV2cRport Double
SNMP v2c trap remote port.
trapV2cStatus String
Enable/disable SNMP v2c trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
events string[]
SNMP trap events. disk_low - Disk usage too high. ha_switch - HA switch. intf_ip_chg - Interface IP address changed. sys_reboot - System reboot. cpu_high - CPU usage too high. mem_low - Available memory is low. log-alert - Log base alert message. log-rate - High incoming log rate detected. log-data-rate - High incoming log data rate detected. lic-gbday - High licensed log GB/day detected. lic-dev-quota - High licensed device quota detected. cpu-high-exclude-nice - CPU usage exclude NICE threshold. Valid values: disk_low, ha_switch, intf_ip_chg, sys_reboot, cpu_high, mem_low, log-alert, log-rate, log-data-rate, lic-gbday, lic-dev-quota, cpu-high-exclude-nice.
fosid number
Community ID.
hosts SystemSnmpCommunityHost[]
Hosts. The structure of hosts block is documented below.
hosts6s SystemSnmpCommunityHosts6[]
Hosts6. The structure of hosts6 block is documented below.
name string
Community name.
queryV1Port number
SNMP v1 query port.
queryV1Status string
Enable/disable SNMP v1 query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
queryV2cPort number
SNMP v2c query port.
queryV2cStatus string
Enable/disable SNMP v2c query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
status string
Enable/disable community. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
systemSnmpCommunityId string
an identifier for the resource with format {{fosid}}.
trapV1Rport number
SNMP v1 trap remote port.
trapV1Status string
Enable/disable SNMP v1 trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
trapV2cRport number
SNMP v2c trap remote port.
trapV2cStatus string
Enable/disable SNMP v2c trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
events Sequence[str]
SNMP trap events. disk_low - Disk usage too high. ha_switch - HA switch. intf_ip_chg - Interface IP address changed. sys_reboot - System reboot. cpu_high - CPU usage too high. mem_low - Available memory is low. log-alert - Log base alert message. log-rate - High incoming log rate detected. log-data-rate - High incoming log data rate detected. lic-gbday - High licensed log GB/day detected. lic-dev-quota - High licensed device quota detected. cpu-high-exclude-nice - CPU usage exclude NICE threshold. Valid values: disk_low, ha_switch, intf_ip_chg, sys_reboot, cpu_high, mem_low, log-alert, log-rate, log-data-rate, lic-gbday, lic-dev-quota, cpu-high-exclude-nice.
fosid float
Community ID.
hosts Sequence[SystemSnmpCommunityHostArgs]
Hosts. The structure of hosts block is documented below.
hosts6s Sequence[SystemSnmpCommunityHosts6Args]
Hosts6. The structure of hosts6 block is documented below.
name str
Community name.
query_v1_port float
SNMP v1 query port.
query_v1_status str
Enable/disable SNMP v1 query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
query_v2c_port float
SNMP v2c query port.
query_v2c_status str
Enable/disable SNMP v2c query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
status str
Enable/disable community. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
system_snmp_community_id str
an identifier for the resource with format {{fosid}}.
trap_v1_rport float
SNMP v1 trap remote port.
trap_v1_status str
Enable/disable SNMP v1 trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
trap_v2c_rport float
SNMP v2c trap remote port.
trap_v2c_status str
Enable/disable SNMP v2c trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
events List<String>
SNMP trap events. disk_low - Disk usage too high. ha_switch - HA switch. intf_ip_chg - Interface IP address changed. sys_reboot - System reboot. cpu_high - CPU usage too high. mem_low - Available memory is low. log-alert - Log base alert message. log-rate - High incoming log rate detected. log-data-rate - High incoming log data rate detected. lic-gbday - High licensed log GB/day detected. lic-dev-quota - High licensed device quota detected. cpu-high-exclude-nice - CPU usage exclude NICE threshold. Valid values: disk_low, ha_switch, intf_ip_chg, sys_reboot, cpu_high, mem_low, log-alert, log-rate, log-data-rate, lic-gbday, lic-dev-quota, cpu-high-exclude-nice.
fosid Number
Community ID.
hosts List<Property Map>
Hosts. The structure of hosts block is documented below.
hosts6s List<Property Map>
Hosts6. The structure of hosts6 block is documented below.
name String
Community name.
queryV1Port Number
SNMP v1 query port.
queryV1Status String
Enable/disable SNMP v1 query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
queryV2cPort Number
SNMP v2c query port.
queryV2cStatus String
Enable/disable SNMP v2c query. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
status String
Enable/disable community. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
systemSnmpCommunityId String
an identifier for the resource with format {{fosid}}.
trapV1Rport Number
SNMP v1 trap remote port.
trapV1Status String
Enable/disable SNMP v1 trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
trapV2cRport Number
SNMP v2c trap remote port.
trapV2cStatus String
Enable/disable SNMP v2c trap. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.

Supporting Types

SystemSnmpCommunityHost
, SystemSnmpCommunityHostArgs

Id double
Host entry ID.
Interface string
Allow interface name.
Ip string
Allow host IP address.
Id float64
Host entry ID.
Interface string
Allow interface name.
Ip string
Allow host IP address.
id Double
Host entry ID.
interface_ String
Allow interface name.
ip String
Allow host IP address.
id number
Host entry ID.
interface string
Allow interface name.
ip string
Allow host IP address.
id float
Host entry ID.
interface str
Allow interface name.
ip str
Allow host IP address.
id Number
Host entry ID.
interface String
Allow interface name.
ip String
Allow host IP address.

SystemSnmpCommunityHosts6
, SystemSnmpCommunityHosts6Args

Id double
an identifier for the resource with format {{fosid}}.
Interface string
Allow interface name.
Ip string
Allow host IP address.
Id float64
an identifier for the resource with format {{fosid}}.
Interface string
Allow interface name.
Ip string
Allow host IP address.
id Double
an identifier for the resource with format {{fosid}}.
interface_ String
Allow interface name.
ip String
Allow host IP address.
id number
an identifier for the resource with format {{fosid}}.
interface string
Allow interface name.
ip string
Allow host IP address.
id float
an identifier for the resource with format {{fosid}}.
interface str
Allow interface name.
ip str
Allow host IP address.
id Number
an identifier for the resource with format {{fosid}}.
interface String
Allow interface name.
ip String
Allow host IP address.

Import

System SnmpCommunity can be imported using any of these accepted formats:

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/systemSnmpCommunity:SystemSnmpCommunity labelname {{fosid}}
Copy

$ unset “FORTIMANAGER_IMPORT_TABLE”

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

Package Details

Repository
fortimanager fortinetdev/terraform-provider-fortimanager
License
Notes
This Pulumi package is based on the fortimanager Terraform Provider.
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager