fortios.system/snmp.Community
Explore with Pulumi AI
SNMP community configuration.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";
const trname = new fortios.system.snmp.Community("trname", {
events: "cpu-high mem-low log-full intf-ip vpn-tun-up vpn-tun-down ha-switch ha-hb-failure ips-signature ips-anomaly av-virus av-oversize av-pattern av-fragmented fm-if-change bgp-established bgp-backward-transition ha-member-up ha-member-down ent-conf-change av-conserve av-bypass av-oversize-passed av-oversize-blocked ips-pkg-update ips-fail-open faz-disconnect wc-ap-up wc-ap-down fswctl-session-up fswctl-session-down load-balance-real-server-down per-cpu-high",
fosid: 1,
queryV1Port: 161,
queryV1Status: "enable",
queryV2cPort: 161,
queryV2cStatus: "enable",
status: "enable",
trapV1Lport: 162,
trapV1Rport: 162,
trapV1Status: "enable",
trapV2cLport: 162,
trapV2cRport: 162,
trapV2cStatus: "enable",
});
import pulumi
import pulumiverse_fortios as fortios
trname = fortios.system.snmp.Community("trname",
events="cpu-high mem-low log-full intf-ip vpn-tun-up vpn-tun-down ha-switch ha-hb-failure ips-signature ips-anomaly av-virus av-oversize av-pattern av-fragmented fm-if-change bgp-established bgp-backward-transition ha-member-up ha-member-down ent-conf-change av-conserve av-bypass av-oversize-passed av-oversize-blocked ips-pkg-update ips-fail-open faz-disconnect wc-ap-up wc-ap-down fswctl-session-up fswctl-session-down load-balance-real-server-down per-cpu-high",
fosid=1,
query_v1_port=161,
query_v1_status="enable",
query_v2c_port=161,
query_v2c_status="enable",
status="enable",
trap_v1_lport=162,
trap_v1_rport=162,
trap_v1_status="enable",
trap_v2c_lport=162,
trap_v2c_rport=162,
trap_v2c_status="enable")
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/system"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := system.NewCommunity(ctx, "trname", &system.CommunityArgs{
Events: pulumi.String("cpu-high mem-low log-full intf-ip vpn-tun-up vpn-tun-down ha-switch ha-hb-failure ips-signature ips-anomaly av-virus av-oversize av-pattern av-fragmented fm-if-change bgp-established bgp-backward-transition ha-member-up ha-member-down ent-conf-change av-conserve av-bypass av-oversize-passed av-oversize-blocked ips-pkg-update ips-fail-open faz-disconnect wc-ap-up wc-ap-down fswctl-session-up fswctl-session-down load-balance-real-server-down per-cpu-high"),
Fosid: pulumi.Int(1),
QueryV1Port: pulumi.Int(161),
QueryV1Status: pulumi.String("enable"),
QueryV2cPort: pulumi.Int(161),
QueryV2cStatus: pulumi.String("enable"),
Status: pulumi.String("enable"),
TrapV1Lport: pulumi.Int(162),
TrapV1Rport: pulumi.Int(162),
TrapV1Status: pulumi.String("enable"),
TrapV2cLport: pulumi.Int(162),
TrapV2cRport: pulumi.Int(162),
TrapV2cStatus: pulumi.String("enable"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;
return await Deployment.RunAsync(() =>
{
var trname = new Fortios.System.Snmp.Community("trname", new()
{
Events = "cpu-high mem-low log-full intf-ip vpn-tun-up vpn-tun-down ha-switch ha-hb-failure ips-signature ips-anomaly av-virus av-oversize av-pattern av-fragmented fm-if-change bgp-established bgp-backward-transition ha-member-up ha-member-down ent-conf-change av-conserve av-bypass av-oversize-passed av-oversize-blocked ips-pkg-update ips-fail-open faz-disconnect wc-ap-up wc-ap-down fswctl-session-up fswctl-session-down load-balance-real-server-down per-cpu-high",
Fosid = 1,
QueryV1Port = 161,
QueryV1Status = "enable",
QueryV2cPort = 161,
QueryV2cStatus = "enable",
Status = "enable",
TrapV1Lport = 162,
TrapV1Rport = 162,
TrapV1Status = "enable",
TrapV2cLport = 162,
TrapV2cRport = 162,
TrapV2cStatus = "enable",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.system.Community;
import com.pulumi.fortios.system.CommunityArgs;
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 Community("trname", CommunityArgs.builder()
.events("cpu-high mem-low log-full intf-ip vpn-tun-up vpn-tun-down ha-switch ha-hb-failure ips-signature ips-anomaly av-virus av-oversize av-pattern av-fragmented fm-if-change bgp-established bgp-backward-transition ha-member-up ha-member-down ent-conf-change av-conserve av-bypass av-oversize-passed av-oversize-blocked ips-pkg-update ips-fail-open faz-disconnect wc-ap-up wc-ap-down fswctl-session-up fswctl-session-down load-balance-real-server-down per-cpu-high")
.fosid(1)
.queryV1Port(161)
.queryV1Status("enable")
.queryV2cPort(161)
.queryV2cStatus("enable")
.status("enable")
.trapV1Lport(162)
.trapV1Rport(162)
.trapV1Status("enable")
.trapV2cLport(162)
.trapV2cRport(162)
.trapV2cStatus("enable")
.build());
}
}
resources:
trname:
type: fortios:system/snmp:Community
properties:
events: cpu-high mem-low log-full intf-ip vpn-tun-up vpn-tun-down ha-switch ha-hb-failure ips-signature ips-anomaly av-virus av-oversize av-pattern av-fragmented fm-if-change bgp-established bgp-backward-transition ha-member-up ha-member-down ent-conf-change av-conserve av-bypass av-oversize-passed av-oversize-blocked ips-pkg-update ips-fail-open faz-disconnect wc-ap-up wc-ap-down fswctl-session-up fswctl-session-down load-balance-real-server-down per-cpu-high
fosid: 1
queryV1Port: 161
queryV1Status: enable
queryV2cPort: 161
queryV2cStatus: enable
status: enable
trapV1Lport: 162
trapV1Rport: 162
trapV1Status: enable
trapV2cLport: 162
trapV2cRport: 162
trapV2cStatus: enable
Create Community Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Community(name: string, args: CommunityArgs, opts?: CustomResourceOptions);
@overload
def Community(resource_name: str,
args: CommunityArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Community(resource_name: str,
opts: Optional[ResourceOptions] = None,
fosid: Optional[int] = None,
query_v2c_port: Optional[int] = None,
trap_v2c_status: Optional[str] = None,
get_all_tables: Optional[str] = None,
hosts: Optional[Sequence[CommunityHostArgs]] = None,
hosts6s: Optional[Sequence[CommunityHosts6Args]] = None,
mib_view: Optional[str] = None,
name: Optional[str] = None,
query_v2c_status: Optional[str] = None,
vdoms: Optional[Sequence[CommunityVdomArgs]] = None,
events: Optional[str] = None,
query_v1_port: Optional[int] = None,
status: Optional[str] = None,
trap_v1_lport: Optional[int] = None,
trap_v1_rport: Optional[int] = None,
trap_v1_status: Optional[str] = None,
trap_v2c_lport: Optional[int] = None,
trap_v2c_rport: Optional[int] = None,
dynamic_sort_subtable: Optional[str] = None,
vdomparam: Optional[str] = None,
query_v1_status: Optional[str] = None)
func NewCommunity(ctx *Context, name string, args CommunityArgs, opts ...ResourceOption) (*Community, error)
public Community(string name, CommunityArgs args, CustomResourceOptions? opts = null)
public Community(String name, CommunityArgs args)
public Community(String name, CommunityArgs args, CustomResourceOptions options)
type: fortios:system/snmp/community:Community
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 CommunityArgs
- 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 CommunityArgs
- 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 CommunityArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CommunityArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CommunityArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Community Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Community resource accepts the following input properties:
- Fosid int
- Community ID.
- Dynamic
Sort stringSubtable - 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 ].
- Events string
- SNMP trap events.
- Get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- Hosts
List<Pulumiverse.
Fortios. System. Snmp. Inputs. Community Host> - Configure IPv4 SNMP managers (hosts). The structure of
hosts
block is documented below. - Hosts6s
List<Pulumiverse.
Fortios. System. Snmp. Inputs. Community Hosts6> - Configure IPv6 SNMP managers. The structure of
hosts6
block is documented below. - Mib
View string - SNMP access control MIB view.
- Name string
- Community name.
- Query
V1Port int - SNMP v1 query port (default = 161).
- Query
V1Status string - Enable/disable SNMP v1 queries. Valid values:
enable
,disable
. - Query
V2c intPort - SNMP v2c query port (default = 161).
- Query
V2c stringStatus - Enable/disable SNMP v2c queries. Valid values:
enable
,disable
. - Status string
- Enable/disable this SNMP community. Valid values:
enable
,disable
. - Trap
V1Lport int - SNMP v1 trap local port (default = 162).
- Trap
V1Rport int - SNMP v1 trap remote port (default = 162).
- Trap
V1Status string - Enable/disable SNMP v1 traps. Valid values:
enable
,disable
. - Trap
V2c intLport - SNMP v2c trap local port (default = 162).
- Trap
V2c intRport - SNMP v2c trap remote port (default = 162).
- Trap
V2c stringStatus - Enable/disable SNMP v2c traps. Valid values:
enable
,disable
. - 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.
- Vdoms
List<Pulumiverse.
Fortios. System. Snmp. Inputs. Community Vdom> - SNMP access control VDOMs. The structure of
vdoms
block is documented below.
- Fosid int
- Community ID.
- Dynamic
Sort stringSubtable - 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 ].
- Events string
- SNMP trap events.
- Get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- Hosts
[]Community
Host Args - Configure IPv4 SNMP managers (hosts). The structure of
hosts
block is documented below. - Hosts6s
[]Community
Hosts6Args - Configure IPv6 SNMP managers. The structure of
hosts6
block is documented below. - Mib
View string - SNMP access control MIB view.
- Name string
- Community name.
- Query
V1Port int - SNMP v1 query port (default = 161).
- Query
V1Status string - Enable/disable SNMP v1 queries. Valid values:
enable
,disable
. - Query
V2c intPort - SNMP v2c query port (default = 161).
- Query
V2c stringStatus - Enable/disable SNMP v2c queries. Valid values:
enable
,disable
. - Status string
- Enable/disable this SNMP community. Valid values:
enable
,disable
. - Trap
V1Lport int - SNMP v1 trap local port (default = 162).
- Trap
V1Rport int - SNMP v1 trap remote port (default = 162).
- Trap
V1Status string - Enable/disable SNMP v1 traps. Valid values:
enable
,disable
. - Trap
V2c intLport - SNMP v2c trap local port (default = 162).
- Trap
V2c intRport - SNMP v2c trap remote port (default = 162).
- Trap
V2c stringStatus - Enable/disable SNMP v2c traps. Valid values:
enable
,disable
. - 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.
- Vdoms
[]Community
Vdom Args - SNMP access control VDOMs. The structure of
vdoms
block is documented below.
- fosid Integer
- Community ID.
- dynamic
Sort StringSubtable - 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 ].
- events String
- SNMP trap events.
- get
All StringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- hosts
List<Community
Host> - Configure IPv4 SNMP managers (hosts). The structure of
hosts
block is documented below. - hosts6s
List<Community
Hosts6> - Configure IPv6 SNMP managers. The structure of
hosts6
block is documented below. - mib
View String - SNMP access control MIB view.
- name String
- Community name.
- query
V1Port Integer - SNMP v1 query port (default = 161).
- query
V1Status String - Enable/disable SNMP v1 queries. Valid values:
enable
,disable
. - query
V2c IntegerPort - SNMP v2c query port (default = 161).
- query
V2c StringStatus - Enable/disable SNMP v2c queries. Valid values:
enable
,disable
. - status String
- Enable/disable this SNMP community. Valid values:
enable
,disable
. - trap
V1Lport Integer - SNMP v1 trap local port (default = 162).
- trap
V1Rport Integer - SNMP v1 trap remote port (default = 162).
- trap
V1Status String - Enable/disable SNMP v1 traps. Valid values:
enable
,disable
. - trap
V2c IntegerLport - SNMP v2c trap local port (default = 162).
- trap
V2c IntegerRport - SNMP v2c trap remote port (default = 162).
- trap
V2c StringStatus - Enable/disable SNMP v2c traps. Valid values:
enable
,disable
. - 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.
- vdoms
List<Community
Vdom> - SNMP access control VDOMs. The structure of
vdoms
block is documented below.
- fosid number
- Community ID.
- dynamic
Sort stringSubtable - 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 ].
- events string
- SNMP trap events.
- get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- hosts
Community
Host[] - Configure IPv4 SNMP managers (hosts). The structure of
hosts
block is documented below. - hosts6s
Community
Hosts6[] - Configure IPv6 SNMP managers. The structure of
hosts6
block is documented below. - mib
View string - SNMP access control MIB view.
- name string
- Community name.
- query
V1Port number - SNMP v1 query port (default = 161).
- query
V1Status string - Enable/disable SNMP v1 queries. Valid values:
enable
,disable
. - query
V2c numberPort - SNMP v2c query port (default = 161).
- query
V2c stringStatus - Enable/disable SNMP v2c queries. Valid values:
enable
,disable
. - status string
- Enable/disable this SNMP community. Valid values:
enable
,disable
. - trap
V1Lport number - SNMP v1 trap local port (default = 162).
- trap
V1Rport number - SNMP v1 trap remote port (default = 162).
- trap
V1Status string - Enable/disable SNMP v1 traps. Valid values:
enable
,disable
. - trap
V2c numberLport - SNMP v2c trap local port (default = 162).
- trap
V2c numberRport - SNMP v2c trap remote port (default = 162).
- trap
V2c stringStatus - Enable/disable SNMP v2c traps. Valid values:
enable
,disable
. - 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.
- vdoms
Community
Vdom[] - SNMP access control VDOMs. The structure of
vdoms
block is documented below.
- fosid int
- Community ID.
- dynamic_
sort_ strsubtable - 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 ].
- events str
- SNMP trap events.
- get_
all_ strtables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- hosts
Sequence[Community
Host Args] - Configure IPv4 SNMP managers (hosts). The structure of
hosts
block is documented below. - hosts6s
Sequence[Community
Hosts6Args] - Configure IPv6 SNMP managers. The structure of
hosts6
block is documented below. - mib_
view str - SNMP access control MIB view.
- name str
- Community name.
- query_
v1_ intport - SNMP v1 query port (default = 161).
- query_
v1_ strstatus - Enable/disable SNMP v1 queries. Valid values:
enable
,disable
. - query_
v2c_ intport - SNMP v2c query port (default = 161).
- query_
v2c_ strstatus - Enable/disable SNMP v2c queries. Valid values:
enable
,disable
. - status str
- Enable/disable this SNMP community. Valid values:
enable
,disable
. - trap_
v1_ intlport - SNMP v1 trap local port (default = 162).
- trap_
v1_ intrport - SNMP v1 trap remote port (default = 162).
- trap_
v1_ strstatus - Enable/disable SNMP v1 traps. Valid values:
enable
,disable
. - trap_
v2c_ intlport - SNMP v2c trap local port (default = 162).
- trap_
v2c_ intrport - SNMP v2c trap remote port (default = 162).
- trap_
v2c_ strstatus - Enable/disable SNMP v2c traps. Valid values:
enable
,disable
. - 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.
- vdoms
Sequence[Community
Vdom Args] - SNMP access control VDOMs. The structure of
vdoms
block is documented below.
- fosid Number
- Community ID.
- dynamic
Sort StringSubtable - 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 ].
- events String
- SNMP trap events.
- get
All StringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- hosts List<Property Map>
- Configure IPv4 SNMP managers (hosts). The structure of
hosts
block is documented below. - hosts6s List<Property Map>
- Configure IPv6 SNMP managers. The structure of
hosts6
block is documented below. - mib
View String - SNMP access control MIB view.
- name String
- Community name.
- query
V1Port Number - SNMP v1 query port (default = 161).
- query
V1Status String - Enable/disable SNMP v1 queries. Valid values:
enable
,disable
. - query
V2c NumberPort - SNMP v2c query port (default = 161).
- query
V2c StringStatus - Enable/disable SNMP v2c queries. Valid values:
enable
,disable
. - status String
- Enable/disable this SNMP community. Valid values:
enable
,disable
. - trap
V1Lport Number - SNMP v1 trap local port (default = 162).
- trap
V1Rport Number - SNMP v1 trap remote port (default = 162).
- trap
V1Status String - Enable/disable SNMP v1 traps. Valid values:
enable
,disable
. - trap
V2c NumberLport - SNMP v2c trap local port (default = 162).
- trap
V2c NumberRport - SNMP v2c trap remote port (default = 162).
- trap
V2c StringStatus - Enable/disable SNMP v2c traps. Valid values:
enable
,disable
. - 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.
- vdoms List<Property Map>
- SNMP access control VDOMs. The structure of
vdoms
block is documented below.
Outputs
All input properties are implicitly available as output properties. Additionally, the Community 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 Community Resource
Get an existing Community 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?: CommunityState, opts?: CustomResourceOptions): Community
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
dynamic_sort_subtable: Optional[str] = None,
events: Optional[str] = None,
fosid: Optional[int] = None,
get_all_tables: Optional[str] = None,
hosts: Optional[Sequence[CommunityHostArgs]] = None,
hosts6s: Optional[Sequence[CommunityHosts6Args]] = None,
mib_view: Optional[str] = None,
name: Optional[str] = None,
query_v1_port: Optional[int] = None,
query_v1_status: Optional[str] = None,
query_v2c_port: Optional[int] = None,
query_v2c_status: Optional[str] = None,
status: Optional[str] = None,
trap_v1_lport: Optional[int] = None,
trap_v1_rport: Optional[int] = None,
trap_v1_status: Optional[str] = None,
trap_v2c_lport: Optional[int] = None,
trap_v2c_rport: Optional[int] = None,
trap_v2c_status: Optional[str] = None,
vdomparam: Optional[str] = None,
vdoms: Optional[Sequence[CommunityVdomArgs]] = None) -> Community
func GetCommunity(ctx *Context, name string, id IDInput, state *CommunityState, opts ...ResourceOption) (*Community, error)
public static Community Get(string name, Input<string> id, CommunityState? state, CustomResourceOptions? opts = null)
public static Community get(String name, Output<String> id, CommunityState 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.
- Dynamic
Sort stringSubtable - 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 ].
- Events string
- SNMP trap events.
- Fosid int
- Community ID.
- Get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- Hosts
List<Pulumiverse.
Fortios. System. Snmp. Inputs. Community Host> - Configure IPv4 SNMP managers (hosts). The structure of
hosts
block is documented below. - Hosts6s
List<Pulumiverse.
Fortios. System. Snmp. Inputs. Community Hosts6> - Configure IPv6 SNMP managers. The structure of
hosts6
block is documented below. - Mib
View string - SNMP access control MIB view.
- Name string
- Community name.
- Query
V1Port int - SNMP v1 query port (default = 161).
- Query
V1Status string - Enable/disable SNMP v1 queries. Valid values:
enable
,disable
. - Query
V2c intPort - SNMP v2c query port (default = 161).
- Query
V2c stringStatus - Enable/disable SNMP v2c queries. Valid values:
enable
,disable
. - Status string
- Enable/disable this SNMP community. Valid values:
enable
,disable
. - Trap
V1Lport int - SNMP v1 trap local port (default = 162).
- Trap
V1Rport int - SNMP v1 trap remote port (default = 162).
- Trap
V1Status string - Enable/disable SNMP v1 traps. Valid values:
enable
,disable
. - Trap
V2c intLport - SNMP v2c trap local port (default = 162).
- Trap
V2c intRport - SNMP v2c trap remote port (default = 162).
- Trap
V2c stringStatus - Enable/disable SNMP v2c traps. Valid values:
enable
,disable
. - 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.
- Vdoms
List<Pulumiverse.
Fortios. System. Snmp. Inputs. Community Vdom> - SNMP access control VDOMs. The structure of
vdoms
block is documented below.
- Dynamic
Sort stringSubtable - 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 ].
- Events string
- SNMP trap events.
- Fosid int
- Community ID.
- Get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- Hosts
[]Community
Host Args - Configure IPv4 SNMP managers (hosts). The structure of
hosts
block is documented below. - Hosts6s
[]Community
Hosts6Args - Configure IPv6 SNMP managers. The structure of
hosts6
block is documented below. - Mib
View string - SNMP access control MIB view.
- Name string
- Community name.
- Query
V1Port int - SNMP v1 query port (default = 161).
- Query
V1Status string - Enable/disable SNMP v1 queries. Valid values:
enable
,disable
. - Query
V2c intPort - SNMP v2c query port (default = 161).
- Query
V2c stringStatus - Enable/disable SNMP v2c queries. Valid values:
enable
,disable
. - Status string
- Enable/disable this SNMP community. Valid values:
enable
,disable
. - Trap
V1Lport int - SNMP v1 trap local port (default = 162).
- Trap
V1Rport int - SNMP v1 trap remote port (default = 162).
- Trap
V1Status string - Enable/disable SNMP v1 traps. Valid values:
enable
,disable
. - Trap
V2c intLport - SNMP v2c trap local port (default = 162).
- Trap
V2c intRport - SNMP v2c trap remote port (default = 162).
- Trap
V2c stringStatus - Enable/disable SNMP v2c traps. Valid values:
enable
,disable
. - 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.
- Vdoms
[]Community
Vdom Args - SNMP access control VDOMs. The structure of
vdoms
block is documented below.
- dynamic
Sort StringSubtable - 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 ].
- events String
- SNMP trap events.
- fosid Integer
- Community ID.
- get
All StringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- hosts
List<Community
Host> - Configure IPv4 SNMP managers (hosts). The structure of
hosts
block is documented below. - hosts6s
List<Community
Hosts6> - Configure IPv6 SNMP managers. The structure of
hosts6
block is documented below. - mib
View String - SNMP access control MIB view.
- name String
- Community name.
- query
V1Port Integer - SNMP v1 query port (default = 161).
- query
V1Status String - Enable/disable SNMP v1 queries. Valid values:
enable
,disable
. - query
V2c IntegerPort - SNMP v2c query port (default = 161).
- query
V2c StringStatus - Enable/disable SNMP v2c queries. Valid values:
enable
,disable
. - status String
- Enable/disable this SNMP community. Valid values:
enable
,disable
. - trap
V1Lport Integer - SNMP v1 trap local port (default = 162).
- trap
V1Rport Integer - SNMP v1 trap remote port (default = 162).
- trap
V1Status String - Enable/disable SNMP v1 traps. Valid values:
enable
,disable
. - trap
V2c IntegerLport - SNMP v2c trap local port (default = 162).
- trap
V2c IntegerRport - SNMP v2c trap remote port (default = 162).
- trap
V2c StringStatus - Enable/disable SNMP v2c traps. Valid values:
enable
,disable
. - 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.
- vdoms
List<Community
Vdom> - SNMP access control VDOMs. The structure of
vdoms
block is documented below.
- dynamic
Sort stringSubtable - 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 ].
- events string
- SNMP trap events.
- fosid number
- Community ID.
- get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- hosts
Community
Host[] - Configure IPv4 SNMP managers (hosts). The structure of
hosts
block is documented below. - hosts6s
Community
Hosts6[] - Configure IPv6 SNMP managers. The structure of
hosts6
block is documented below. - mib
View string - SNMP access control MIB view.
- name string
- Community name.
- query
V1Port number - SNMP v1 query port (default = 161).
- query
V1Status string - Enable/disable SNMP v1 queries. Valid values:
enable
,disable
. - query
V2c numberPort - SNMP v2c query port (default = 161).
- query
V2c stringStatus - Enable/disable SNMP v2c queries. Valid values:
enable
,disable
. - status string
- Enable/disable this SNMP community. Valid values:
enable
,disable
. - trap
V1Lport number - SNMP v1 trap local port (default = 162).
- trap
V1Rport number - SNMP v1 trap remote port (default = 162).
- trap
V1Status string - Enable/disable SNMP v1 traps. Valid values:
enable
,disable
. - trap
V2c numberLport - SNMP v2c trap local port (default = 162).
- trap
V2c numberRport - SNMP v2c trap remote port (default = 162).
- trap
V2c stringStatus - Enable/disable SNMP v2c traps. Valid values:
enable
,disable
. - 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.
- vdoms
Community
Vdom[] - SNMP access control VDOMs. The structure of
vdoms
block is documented below.
- dynamic_
sort_ strsubtable - 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 ].
- events str
- SNMP trap events.
- fosid int
- Community ID.
- get_
all_ strtables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- hosts
Sequence[Community
Host Args] - Configure IPv4 SNMP managers (hosts). The structure of
hosts
block is documented below. - hosts6s
Sequence[Community
Hosts6Args] - Configure IPv6 SNMP managers. The structure of
hosts6
block is documented below. - mib_
view str - SNMP access control MIB view.
- name str
- Community name.
- query_
v1_ intport - SNMP v1 query port (default = 161).
- query_
v1_ strstatus - Enable/disable SNMP v1 queries. Valid values:
enable
,disable
. - query_
v2c_ intport - SNMP v2c query port (default = 161).
- query_
v2c_ strstatus - Enable/disable SNMP v2c queries. Valid values:
enable
,disable
. - status str
- Enable/disable this SNMP community. Valid values:
enable
,disable
. - trap_
v1_ intlport - SNMP v1 trap local port (default = 162).
- trap_
v1_ intrport - SNMP v1 trap remote port (default = 162).
- trap_
v1_ strstatus - Enable/disable SNMP v1 traps. Valid values:
enable
,disable
. - trap_
v2c_ intlport - SNMP v2c trap local port (default = 162).
- trap_
v2c_ intrport - SNMP v2c trap remote port (default = 162).
- trap_
v2c_ strstatus - Enable/disable SNMP v2c traps. Valid values:
enable
,disable
. - 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.
- vdoms
Sequence[Community
Vdom Args] - SNMP access control VDOMs. The structure of
vdoms
block is documented below.
- dynamic
Sort StringSubtable - 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 ].
- events String
- SNMP trap events.
- fosid Number
- Community ID.
- get
All StringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- hosts List<Property Map>
- Configure IPv4 SNMP managers (hosts). The structure of
hosts
block is documented below. - hosts6s List<Property Map>
- Configure IPv6 SNMP managers. The structure of
hosts6
block is documented below. - mib
View String - SNMP access control MIB view.
- name String
- Community name.
- query
V1Port Number - SNMP v1 query port (default = 161).
- query
V1Status String - Enable/disable SNMP v1 queries. Valid values:
enable
,disable
. - query
V2c NumberPort - SNMP v2c query port (default = 161).
- query
V2c StringStatus - Enable/disable SNMP v2c queries. Valid values:
enable
,disable
. - status String
- Enable/disable this SNMP community. Valid values:
enable
,disable
. - trap
V1Lport Number - SNMP v1 trap local port (default = 162).
- trap
V1Rport Number - SNMP v1 trap remote port (default = 162).
- trap
V1Status String - Enable/disable SNMP v1 traps. Valid values:
enable
,disable
. - trap
V2c NumberLport - SNMP v2c trap local port (default = 162).
- trap
V2c NumberRport - SNMP v2c trap remote port (default = 162).
- trap
V2c StringStatus - Enable/disable SNMP v2c traps. Valid values:
enable
,disable
. - 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.
- vdoms List<Property Map>
- SNMP access control VDOMs. The structure of
vdoms
block is documented below.
Supporting Types
CommunityHost, CommunityHostArgs
- Ha
Direct string - Enable/disable direct management of HA cluster members. Valid values:
enable
,disable
. - Host
Type string - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. Valid values:
any
,query
,trap
. - Id int
- Host6 entry ID.
- Ip string
- IPv4 address of the SNMP manager (host).
- Source
Ip string - Source IPv4 address for SNMP traps.
- Ha
Direct string - Enable/disable direct management of HA cluster members. Valid values:
enable
,disable
. - Host
Type string - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. Valid values:
any
,query
,trap
. - Id int
- Host6 entry ID.
- Ip string
- IPv4 address of the SNMP manager (host).
- Source
Ip string - Source IPv4 address for SNMP traps.
- ha
Direct String - Enable/disable direct management of HA cluster members. Valid values:
enable
,disable
. - host
Type String - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. Valid values:
any
,query
,trap
. - id Integer
- Host6 entry ID.
- ip String
- IPv4 address of the SNMP manager (host).
- source
Ip String - Source IPv4 address for SNMP traps.
- ha
Direct string - Enable/disable direct management of HA cluster members. Valid values:
enable
,disable
. - host
Type string - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. Valid values:
any
,query
,trap
. - id number
- Host6 entry ID.
- ip string
- IPv4 address of the SNMP manager (host).
- source
Ip string - Source IPv4 address for SNMP traps.
- ha_
direct str - Enable/disable direct management of HA cluster members. Valid values:
enable
,disable
. - host_
type str - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. Valid values:
any
,query
,trap
. - id int
- Host6 entry ID.
- ip str
- IPv4 address of the SNMP manager (host).
- source_
ip str - Source IPv4 address for SNMP traps.
- ha
Direct String - Enable/disable direct management of HA cluster members. Valid values:
enable
,disable
. - host
Type String - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. Valid values:
any
,query
,trap
. - id Number
- Host6 entry ID.
- ip String
- IPv4 address of the SNMP manager (host).
- source
Ip String - Source IPv4 address for SNMP traps.
CommunityHosts6, CommunityHosts6Args
- Ha
Direct string - Enable/disable direct management of HA cluster members. Valid values:
enable
,disable
. - Host
Type string - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. Valid values:
any
,query
,trap
. - Id int
- Host6 entry ID.
- Ipv6 string
- SNMP manager IPv6 address prefix.
- Source
Ipv6 string - Source IPv6 address for SNMP traps.
- Ha
Direct string - Enable/disable direct management of HA cluster members. Valid values:
enable
,disable
. - Host
Type string - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. Valid values:
any
,query
,trap
. - Id int
- Host6 entry ID.
- Ipv6 string
- SNMP manager IPv6 address prefix.
- Source
Ipv6 string - Source IPv6 address for SNMP traps.
- ha
Direct String - Enable/disable direct management of HA cluster members. Valid values:
enable
,disable
. - host
Type String - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. Valid values:
any
,query
,trap
. - id Integer
- Host6 entry ID.
- ipv6 String
- SNMP manager IPv6 address prefix.
- source
Ipv6 String - Source IPv6 address for SNMP traps.
- ha
Direct string - Enable/disable direct management of HA cluster members. Valid values:
enable
,disable
. - host
Type string - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. Valid values:
any
,query
,trap
. - id number
- Host6 entry ID.
- ipv6 string
- SNMP manager IPv6 address prefix.
- source
Ipv6 string - Source IPv6 address for SNMP traps.
- ha_
direct str - Enable/disable direct management of HA cluster members. Valid values:
enable
,disable
. - host_
type str - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. Valid values:
any
,query
,trap
. - id int
- Host6 entry ID.
- ipv6 str
- SNMP manager IPv6 address prefix.
- source_
ipv6 str - Source IPv6 address for SNMP traps.
- ha
Direct String - Enable/disable direct management of HA cluster members. Valid values:
enable
,disable
. - host
Type String - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. Valid values:
any
,query
,trap
. - id Number
- Host6 entry ID.
- ipv6 String
- SNMP manager IPv6 address prefix.
- source
Ipv6 String - Source IPv6 address for SNMP traps.
CommunityVdom, CommunityVdomArgs
- Name string
- VDOM name
- Name string
- VDOM name
- name String
- VDOM name
- name string
- VDOM name
- name str
- VDOM name
- name String
- VDOM name
Import
SystemSnmp Community can be imported using any of these accepted formats:
$ pulumi import fortios:system/snmp/community:Community labelname {{fosid}}
If you do not want to import arguments of block:
$ export “FORTIOS_IMPORT_TABLE”=“false”
$ pulumi import fortios:system/snmp/community:Community labelname {{fosid}}
$ 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.