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

fortios.switchcontroller.Snmpcommunity

Explore with Pulumi AI

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

Configure FortiSwitch SNMP v1/v2c communities globally. Applies to FortiOS Version >= 6.2.4.

Create Snmpcommunity Resource

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

Constructor syntax

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

@overload
def Snmpcommunity(resource_name: 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[SnmpcommunityHostArgs]] = 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)
func NewSnmpcommunity(ctx *Context, name string, args *SnmpcommunityArgs, opts ...ResourceOption) (*Snmpcommunity, error)
public Snmpcommunity(string name, SnmpcommunityArgs? args = null, CustomResourceOptions? opts = null)
public Snmpcommunity(String name, SnmpcommunityArgs args)
public Snmpcommunity(String name, SnmpcommunityArgs args, CustomResourceOptions options)

type: fortios:switchcontroller:Snmpcommunity
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 SnmpcommunityArgs
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 SnmpcommunityArgs
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 SnmpcommunityArgs
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 SnmpcommunityArgs
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. SnmpcommunityArgs
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 snmpcommunityResource = new Fortios.Switchcontroller.Snmpcommunity("snmpcommunityResource", new()
{
    DynamicSortSubtable = "string",
    Events = "string",
    Fosid = 0,
    GetAllTables = "string",
    Hosts = new[]
    {
        new Fortios.Switchcontroller.Inputs.SnmpcommunityHostArgs
        {
            Id = 0,
            Ip = "string",
        },
    },
    Name = "string",
    QueryV1Port = 0,
    QueryV1Status = "string",
    QueryV2cPort = 0,
    QueryV2cStatus = "string",
    Status = "string",
    TrapV1Lport = 0,
    TrapV1Rport = 0,
    TrapV1Status = "string",
    TrapV2cLport = 0,
    TrapV2cRport = 0,
    TrapV2cStatus = "string",
    Vdomparam = "string",
});
Copy
example, err := switchcontroller.NewSnmpcommunity(ctx, "snmpcommunityResource", &switchcontroller.SnmpcommunityArgs{
	DynamicSortSubtable: pulumi.String("string"),
	Events:              pulumi.String("string"),
	Fosid:               pulumi.Int(0),
	GetAllTables:        pulumi.String("string"),
	Hosts: switchcontroller.SnmpcommunityHostArray{
		&switchcontroller.SnmpcommunityHostArgs{
			Id: pulumi.Int(0),
			Ip: pulumi.String("string"),
		},
	},
	Name:           pulumi.String("string"),
	QueryV1Port:    pulumi.Int(0),
	QueryV1Status:  pulumi.String("string"),
	QueryV2cPort:   pulumi.Int(0),
	QueryV2cStatus: pulumi.String("string"),
	Status:         pulumi.String("string"),
	TrapV1Lport:    pulumi.Int(0),
	TrapV1Rport:    pulumi.Int(0),
	TrapV1Status:   pulumi.String("string"),
	TrapV2cLport:   pulumi.Int(0),
	TrapV2cRport:   pulumi.Int(0),
	TrapV2cStatus:  pulumi.String("string"),
	Vdomparam:      pulumi.String("string"),
})
Copy
var snmpcommunityResource = new Snmpcommunity("snmpcommunityResource", SnmpcommunityArgs.builder()
    .dynamicSortSubtable("string")
    .events("string")
    .fosid(0)
    .getAllTables("string")
    .hosts(SnmpcommunityHostArgs.builder()
        .id(0)
        .ip("string")
        .build())
    .name("string")
    .queryV1Port(0)
    .queryV1Status("string")
    .queryV2cPort(0)
    .queryV2cStatus("string")
    .status("string")
    .trapV1Lport(0)
    .trapV1Rport(0)
    .trapV1Status("string")
    .trapV2cLport(0)
    .trapV2cRport(0)
    .trapV2cStatus("string")
    .vdomparam("string")
    .build());
Copy
snmpcommunity_resource = fortios.switchcontroller.Snmpcommunity("snmpcommunityResource",
    dynamic_sort_subtable="string",
    events="string",
    fosid=0,
    get_all_tables="string",
    hosts=[{
        "id": 0,
        "ip": "string",
    }],
    name="string",
    query_v1_port=0,
    query_v1_status="string",
    query_v2c_port=0,
    query_v2c_status="string",
    status="string",
    trap_v1_lport=0,
    trap_v1_rport=0,
    trap_v1_status="string",
    trap_v2c_lport=0,
    trap_v2c_rport=0,
    trap_v2c_status="string",
    vdomparam="string")
Copy
const snmpcommunityResource = new fortios.switchcontroller.Snmpcommunity("snmpcommunityResource", {
    dynamicSortSubtable: "string",
    events: "string",
    fosid: 0,
    getAllTables: "string",
    hosts: [{
        id: 0,
        ip: "string",
    }],
    name: "string",
    queryV1Port: 0,
    queryV1Status: "string",
    queryV2cPort: 0,
    queryV2cStatus: "string",
    status: "string",
    trapV1Lport: 0,
    trapV1Rport: 0,
    trapV1Status: "string",
    trapV2cLport: 0,
    trapV2cRport: 0,
    trapV2cStatus: "string",
    vdomparam: "string",
});
Copy
type: fortios:switchcontroller:Snmpcommunity
properties:
    dynamicSortSubtable: string
    events: string
    fosid: 0
    getAllTables: string
    hosts:
        - id: 0
          ip: string
    name: string
    queryV1Port: 0
    queryV1Status: string
    queryV2cPort: 0
    queryV2cStatus: string
    status: string
    trapV1Lport: 0
    trapV1Rport: 0
    trapV1Status: string
    trapV2cLport: 0
    trapV2cRport: 0
    trapV2cStatus: string
    vdomparam: string
Copy

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

DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Events string
SNMP notifications (traps) to send. Valid values: cpu-high, mem-low, log-full, intf-ip, ent-conf-change.
Fosid Changes to this property will trigger replacement. int
SNMP community ID.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Hosts List<Pulumiverse.Fortios.Switchcontroller.Inputs.SnmpcommunityHost>
Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
Name string
SNMP community name.
QueryV1Port int
SNMP v1 query port (default = 161).
QueryV1Status string
Enable/disable SNMP v1 queries. Valid values: disable, enable.
QueryV2cPort int
SNMP v2c query port (default = 161).
QueryV2cStatus string
Enable/disable SNMP v2c queries. Valid values: disable, enable.
Status string
Enable/disable this SNMP community. Valid values: disable, enable.
TrapV1Lport int
SNMP v2c trap local port (default = 162).
TrapV1Rport int
SNMP v2c trap remote port (default = 162).
TrapV1Status string
Enable/disable SNMP v1 traps. Valid values: disable, enable.
TrapV2cLport int
SNMP v2c trap local port (default = 162).
TrapV2cRport int
SNMP v2c trap remote port (default = 162).
TrapV2cStatus string
Enable/disable SNMP v2c traps. Valid values: disable, enable.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Events string
SNMP notifications (traps) to send. Valid values: cpu-high, mem-low, log-full, intf-ip, ent-conf-change.
Fosid Changes to this property will trigger replacement. int
SNMP community ID.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Hosts []SnmpcommunityHostArgs
Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
Name string
SNMP community name.
QueryV1Port int
SNMP v1 query port (default = 161).
QueryV1Status string
Enable/disable SNMP v1 queries. Valid values: disable, enable.
QueryV2cPort int
SNMP v2c query port (default = 161).
QueryV2cStatus string
Enable/disable SNMP v2c queries. Valid values: disable, enable.
Status string
Enable/disable this SNMP community. Valid values: disable, enable.
TrapV1Lport int
SNMP v2c trap local port (default = 162).
TrapV1Rport int
SNMP v2c trap remote port (default = 162).
TrapV1Status string
Enable/disable SNMP v1 traps. Valid values: disable, enable.
TrapV2cLport int
SNMP v2c trap local port (default = 162).
TrapV2cRport int
SNMP v2c trap remote port (default = 162).
TrapV2cStatus string
Enable/disable SNMP v2c traps. Valid values: disable, enable.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
events String
SNMP notifications (traps) to send. Valid values: cpu-high, mem-low, log-full, intf-ip, ent-conf-change.
fosid Changes to this property will trigger replacement. Integer
SNMP community ID.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
hosts List<SnmpcommunityHost>
Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
name String
SNMP community name.
queryV1Port Integer
SNMP v1 query port (default = 161).
queryV1Status String
Enable/disable SNMP v1 queries. Valid values: disable, enable.
queryV2cPort Integer
SNMP v2c query port (default = 161).
queryV2cStatus String
Enable/disable SNMP v2c queries. Valid values: disable, enable.
status String
Enable/disable this SNMP community. Valid values: disable, enable.
trapV1Lport Integer
SNMP v2c trap local port (default = 162).
trapV1Rport Integer
SNMP v2c trap remote port (default = 162).
trapV1Status String
Enable/disable SNMP v1 traps. Valid values: disable, enable.
trapV2cLport Integer
SNMP v2c trap local port (default = 162).
trapV2cRport Integer
SNMP v2c trap remote port (default = 162).
trapV2cStatus String
Enable/disable SNMP v2c traps. Valid values: disable, enable.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
events string
SNMP notifications (traps) to send. Valid values: cpu-high, mem-low, log-full, intf-ip, ent-conf-change.
fosid Changes to this property will trigger replacement. number
SNMP community ID.
getAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
hosts SnmpcommunityHost[]
Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
name string
SNMP community name.
queryV1Port number
SNMP v1 query port (default = 161).
queryV1Status string
Enable/disable SNMP v1 queries. Valid values: disable, enable.
queryV2cPort number
SNMP v2c query port (default = 161).
queryV2cStatus string
Enable/disable SNMP v2c queries. Valid values: disable, enable.
status string
Enable/disable this SNMP community. Valid values: disable, enable.
trapV1Lport number
SNMP v2c trap local port (default = 162).
trapV1Rport number
SNMP v2c trap remote port (default = 162).
trapV1Status string
Enable/disable SNMP v1 traps. Valid values: disable, enable.
trapV2cLport number
SNMP v2c trap local port (default = 162).
trapV2cRport number
SNMP v2c trap remote port (default = 162).
trapV2cStatus string
Enable/disable SNMP v2c traps. Valid values: disable, enable.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
events str
SNMP notifications (traps) to send. Valid values: cpu-high, mem-low, log-full, intf-ip, ent-conf-change.
fosid Changes to this property will trigger replacement. int
SNMP community ID.
get_all_tables str
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
hosts Sequence[SnmpcommunityHostArgs]
Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
name str
SNMP community name.
query_v1_port int
SNMP v1 query port (default = 161).
query_v1_status str
Enable/disable SNMP v1 queries. Valid values: disable, enable.
query_v2c_port int
SNMP v2c query port (default = 161).
query_v2c_status str
Enable/disable SNMP v2c queries. Valid values: disable, enable.
status str
Enable/disable this SNMP community. Valid values: disable, enable.
trap_v1_lport int
SNMP v2c trap local port (default = 162).
trap_v1_rport int
SNMP v2c trap remote port (default = 162).
trap_v1_status str
Enable/disable SNMP v1 traps. Valid values: disable, enable.
trap_v2c_lport int
SNMP v2c trap local port (default = 162).
trap_v2c_rport int
SNMP v2c trap remote port (default = 162).
trap_v2c_status str
Enable/disable SNMP v2c traps. Valid values: disable, enable.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
events String
SNMP notifications (traps) to send. Valid values: cpu-high, mem-low, log-full, intf-ip, ent-conf-change.
fosid Changes to this property will trigger replacement. Number
SNMP community ID.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
hosts List<Property Map>
Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
name String
SNMP community name.
queryV1Port Number
SNMP v1 query port (default = 161).
queryV1Status String
Enable/disable SNMP v1 queries. Valid values: disable, enable.
queryV2cPort Number
SNMP v2c query port (default = 161).
queryV2cStatus String
Enable/disable SNMP v2c queries. Valid values: disable, enable.
status String
Enable/disable this SNMP community. Valid values: disable, enable.
trapV1Lport Number
SNMP v2c trap local port (default = 162).
trapV1Rport Number
SNMP v2c trap remote port (default = 162).
trapV1Status String
Enable/disable SNMP v1 traps. Valid values: disable, enable.
trapV2cLport Number
SNMP v2c trap local port (default = 162).
trapV2cRport Number
SNMP v2c trap remote port (default = 162).
trapV2cStatus String
Enable/disable SNMP v2c traps. Valid values: disable, enable.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Outputs

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

Get an existing Snmpcommunity 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?: SnmpcommunityState, opts?: CustomResourceOptions): Snmpcommunity
@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[SnmpcommunityHostArgs]] = 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) -> Snmpcommunity
func GetSnmpcommunity(ctx *Context, name string, id IDInput, state *SnmpcommunityState, opts ...ResourceOption) (*Snmpcommunity, error)
public static Snmpcommunity Get(string name, Input<string> id, SnmpcommunityState? state, CustomResourceOptions? opts = null)
public static Snmpcommunity get(String name, Output<String> id, SnmpcommunityState state, CustomResourceOptions options)
resources:  _:    type: fortios:switchcontroller:Snmpcommunity    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
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 notifications (traps) to send. Valid values: cpu-high, mem-low, log-full, intf-ip, ent-conf-change.
Fosid Changes to this property will trigger replacement. int
SNMP community ID.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Hosts List<Pulumiverse.Fortios.Switchcontroller.Inputs.SnmpcommunityHost>
Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
Name string
SNMP community name.
QueryV1Port int
SNMP v1 query port (default = 161).
QueryV1Status string
Enable/disable SNMP v1 queries. Valid values: disable, enable.
QueryV2cPort int
SNMP v2c query port (default = 161).
QueryV2cStatus string
Enable/disable SNMP v2c queries. Valid values: disable, enable.
Status string
Enable/disable this SNMP community. Valid values: disable, enable.
TrapV1Lport int
SNMP v2c trap local port (default = 162).
TrapV1Rport int
SNMP v2c trap remote port (default = 162).
TrapV1Status string
Enable/disable SNMP v1 traps. Valid values: disable, enable.
TrapV2cLport int
SNMP v2c trap local port (default = 162).
TrapV2cRport int
SNMP v2c trap remote port (default = 162).
TrapV2cStatus string
Enable/disable SNMP v2c traps. Valid values: disable, enable.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Events string
SNMP notifications (traps) to send. Valid values: cpu-high, mem-low, log-full, intf-ip, ent-conf-change.
Fosid Changes to this property will trigger replacement. int
SNMP community ID.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Hosts []SnmpcommunityHostArgs
Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
Name string
SNMP community name.
QueryV1Port int
SNMP v1 query port (default = 161).
QueryV1Status string
Enable/disable SNMP v1 queries. Valid values: disable, enable.
QueryV2cPort int
SNMP v2c query port (default = 161).
QueryV2cStatus string
Enable/disable SNMP v2c queries. Valid values: disable, enable.
Status string
Enable/disable this SNMP community. Valid values: disable, enable.
TrapV1Lport int
SNMP v2c trap local port (default = 162).
TrapV1Rport int
SNMP v2c trap remote port (default = 162).
TrapV1Status string
Enable/disable SNMP v1 traps. Valid values: disable, enable.
TrapV2cLport int
SNMP v2c trap local port (default = 162).
TrapV2cRport int
SNMP v2c trap remote port (default = 162).
TrapV2cStatus string
Enable/disable SNMP v2c traps. Valid values: disable, enable.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
events String
SNMP notifications (traps) to send. Valid values: cpu-high, mem-low, log-full, intf-ip, ent-conf-change.
fosid Changes to this property will trigger replacement. Integer
SNMP community ID.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
hosts List<SnmpcommunityHost>
Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
name String
SNMP community name.
queryV1Port Integer
SNMP v1 query port (default = 161).
queryV1Status String
Enable/disable SNMP v1 queries. Valid values: disable, enable.
queryV2cPort Integer
SNMP v2c query port (default = 161).
queryV2cStatus String
Enable/disable SNMP v2c queries. Valid values: disable, enable.
status String
Enable/disable this SNMP community. Valid values: disable, enable.
trapV1Lport Integer
SNMP v2c trap local port (default = 162).
trapV1Rport Integer
SNMP v2c trap remote port (default = 162).
trapV1Status String
Enable/disable SNMP v1 traps. Valid values: disable, enable.
trapV2cLport Integer
SNMP v2c trap local port (default = 162).
trapV2cRport Integer
SNMP v2c trap remote port (default = 162).
trapV2cStatus String
Enable/disable SNMP v2c traps. Valid values: disable, enable.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
events string
SNMP notifications (traps) to send. Valid values: cpu-high, mem-low, log-full, intf-ip, ent-conf-change.
fosid Changes to this property will trigger replacement. number
SNMP community ID.
getAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
hosts SnmpcommunityHost[]
Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
name string
SNMP community name.
queryV1Port number
SNMP v1 query port (default = 161).
queryV1Status string
Enable/disable SNMP v1 queries. Valid values: disable, enable.
queryV2cPort number
SNMP v2c query port (default = 161).
queryV2cStatus string
Enable/disable SNMP v2c queries. Valid values: disable, enable.
status string
Enable/disable this SNMP community. Valid values: disable, enable.
trapV1Lport number
SNMP v2c trap local port (default = 162).
trapV1Rport number
SNMP v2c trap remote port (default = 162).
trapV1Status string
Enable/disable SNMP v1 traps. Valid values: disable, enable.
trapV2cLport number
SNMP v2c trap local port (default = 162).
trapV2cRport number
SNMP v2c trap remote port (default = 162).
trapV2cStatus string
Enable/disable SNMP v2c traps. Valid values: disable, enable.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
events str
SNMP notifications (traps) to send. Valid values: cpu-high, mem-low, log-full, intf-ip, ent-conf-change.
fosid Changes to this property will trigger replacement. int
SNMP community ID.
get_all_tables str
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
hosts Sequence[SnmpcommunityHostArgs]
Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
name str
SNMP community name.
query_v1_port int
SNMP v1 query port (default = 161).
query_v1_status str
Enable/disable SNMP v1 queries. Valid values: disable, enable.
query_v2c_port int
SNMP v2c query port (default = 161).
query_v2c_status str
Enable/disable SNMP v2c queries. Valid values: disable, enable.
status str
Enable/disable this SNMP community. Valid values: disable, enable.
trap_v1_lport int
SNMP v2c trap local port (default = 162).
trap_v1_rport int
SNMP v2c trap remote port (default = 162).
trap_v1_status str
Enable/disable SNMP v1 traps. Valid values: disable, enable.
trap_v2c_lport int
SNMP v2c trap local port (default = 162).
trap_v2c_rport int
SNMP v2c trap remote port (default = 162).
trap_v2c_status str
Enable/disable SNMP v2c traps. Valid values: disable, enable.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
events String
SNMP notifications (traps) to send. Valid values: cpu-high, mem-low, log-full, intf-ip, ent-conf-change.
fosid Changes to this property will trigger replacement. Number
SNMP community ID.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
hosts List<Property Map>
Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
name String
SNMP community name.
queryV1Port Number
SNMP v1 query port (default = 161).
queryV1Status String
Enable/disable SNMP v1 queries. Valid values: disable, enable.
queryV2cPort Number
SNMP v2c query port (default = 161).
queryV2cStatus String
Enable/disable SNMP v2c queries. Valid values: disable, enable.
status String
Enable/disable this SNMP community. Valid values: disable, enable.
trapV1Lport Number
SNMP v2c trap local port (default = 162).
trapV1Rport Number
SNMP v2c trap remote port (default = 162).
trapV1Status String
Enable/disable SNMP v1 traps. Valid values: disable, enable.
trapV2cLport Number
SNMP v2c trap local port (default = 162).
trapV2cRport Number
SNMP v2c trap remote port (default = 162).
trapV2cStatus String
Enable/disable SNMP v2c traps. Valid values: disable, enable.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Supporting Types

SnmpcommunityHost
, SnmpcommunityHostArgs

Id int
Host entry ID.
Ip string
IPv4 address of the SNMP manager (host).
Id int
Host entry ID.
Ip string
IPv4 address of the SNMP manager (host).
id Integer
Host entry ID.
ip String
IPv4 address of the SNMP manager (host).
id number
Host entry ID.
ip string
IPv4 address of the SNMP manager (host).
id int
Host entry ID.
ip str
IPv4 address of the SNMP manager (host).
id Number
Host entry ID.
ip String
IPv4 address of the SNMP manager (host).

Import

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

$ pulumi import fortios:switchcontroller/snmpcommunity:Snmpcommunity labelname {{fosid}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:switchcontroller/snmpcommunity:Snmpcommunity labelname {{fosid}}
Copy

$ unset “FORTIOS_IMPORT_TABLE”

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

Package Details

Repository
fortios pulumiverse/pulumi-fortios
License
Apache-2.0
Notes
This Pulumi package is based on the fortios Terraform Provider.
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios