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

fortios.system/snmp.User

Explore with Pulumi AI

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

SNMP user configuration.

Example Usage

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

const trname = new fortios.system.snmp.User("trname", {
    authProto: "sha",
    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",
    haDirect: "disable",
    privProto: "aes",
    queries: "disable",
    queryPort: 161,
    securityLevel: "no-auth-no-priv",
    sourceIp: "0.0.0.0",
    sourceIpv6: "::",
    status: "disable",
    trapLport: 162,
    trapRport: 162,
    trapStatus: "enable",
});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname = fortios.system.snmp.User("trname",
    auth_proto="sha",
    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",
    ha_direct="disable",
    priv_proto="aes",
    queries="disable",
    query_port=161,
    security_level="no-auth-no-priv",
    source_ip="0.0.0.0",
    source_ipv6="::",
    status="disable",
    trap_lport=162,
    trap_rport=162,
    trap_status="enable")
Copy
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.NewUser(ctx, "trname", &system.UserArgs{
			AuthProto:     pulumi.String("sha"),
			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"),
			HaDirect:      pulumi.String("disable"),
			PrivProto:     pulumi.String("aes"),
			Queries:       pulumi.String("disable"),
			QueryPort:     pulumi.Int(161),
			SecurityLevel: pulumi.String("no-auth-no-priv"),
			SourceIp:      pulumi.String("0.0.0.0"),
			SourceIpv6:    pulumi.String("::"),
			Status:        pulumi.String("disable"),
			TrapLport:     pulumi.Int(162),
			TrapRport:     pulumi.Int(162),
			TrapStatus:    pulumi.String("enable"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.System.Snmp.User("trname", new()
    {
        AuthProto = "sha",
        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",
        HaDirect = "disable",
        PrivProto = "aes",
        Queries = "disable",
        QueryPort = 161,
        SecurityLevel = "no-auth-no-priv",
        SourceIp = "0.0.0.0",
        SourceIpv6 = "::",
        Status = "disable",
        TrapLport = 162,
        TrapRport = 162,
        TrapStatus = "enable",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.system.User;
import com.pulumi.fortios.system.UserArgs;
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 User("trname", UserArgs.builder()
            .authProto("sha")
            .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")
            .haDirect("disable")
            .privProto("aes")
            .queries("disable")
            .queryPort(161)
            .securityLevel("no-auth-no-priv")
            .sourceIp("0.0.0.0")
            .sourceIpv6("::")
            .status("disable")
            .trapLport(162)
            .trapRport(162)
            .trapStatus("enable")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortios:system/snmp:User
    properties:
      authProto: sha
      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
      haDirect: disable
      privProto: aes
      queries: disable
      queryPort: 161
      securityLevel: no-auth-no-priv
      sourceIp: 0.0.0.0
      sourceIpv6: '::'
      status: disable
      trapLport: 162
      trapRport: 162
      trapStatus: enable
Copy

Create User Resource

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

Constructor syntax

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

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         auth_proto: Optional[str] = None,
         auth_pwd: Optional[str] = None,
         dynamic_sort_subtable: Optional[str] = None,
         events: Optional[str] = None,
         get_all_tables: Optional[str] = None,
         ha_direct: Optional[str] = None,
         mib_view: Optional[str] = None,
         name: Optional[str] = None,
         notify_hosts: Optional[str] = None,
         notify_hosts6: Optional[str] = None,
         priv_proto: Optional[str] = None,
         priv_pwd: Optional[str] = None,
         queries: Optional[str] = None,
         query_port: Optional[int] = None,
         security_level: Optional[str] = None,
         source_ip: Optional[str] = None,
         source_ipv6: Optional[str] = None,
         status: Optional[str] = None,
         trap_lport: Optional[int] = None,
         trap_rport: Optional[int] = None,
         trap_status: Optional[str] = None,
         vdomparam: Optional[str] = None,
         vdoms: Optional[Sequence[UserVdomArgs]] = None)
func NewUser(ctx *Context, name string, args *UserArgs, opts ...ResourceOption) (*User, error)
public User(string name, UserArgs? args = null, CustomResourceOptions? opts = null)
public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

type: fortios:system/snmp/user:User
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 UserArgs
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 UserArgs
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 UserArgs
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 UserArgs
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. UserArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

AuthProto string
Authentication protocol.
AuthPwd string
Password for authentication protocol.
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.
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.
HaDirect string
Enable/disable direct management of HA cluster members. Valid values: enable, disable.
MibView string
SNMP access control MIB view.
Name Changes to this property will trigger replacement. string
SNMP user name.
NotifyHosts string
SNMP managers to send notifications (traps) to.
NotifyHosts6 string
IPv6 SNMP managers to send notifications (traps) to.
PrivProto string
Privacy (encryption) protocol. Valid values: aes, des, aes256, aes256cisco.
PrivPwd string
Password for privacy (encryption) protocol.
Queries string
Enable/disable SNMP queries for this user. Valid values: enable, disable.
QueryPort int
SNMPv3 query port (default = 161).
SecurityLevel string
Security level for message authentication and encryption. Valid values: no-auth-no-priv, auth-no-priv, auth-priv.
SourceIp string
Source IP for SNMP trap.
SourceIpv6 string
Source IPv6 for SNMP trap.
Status string
Enable/disable this SNMP user. Valid values: enable, disable.
TrapLport int
SNMPv3 local trap port (default = 162).
TrapRport int
SNMPv3 trap remote port (default = 162).
TrapStatus string
Enable/disable traps for this SNMP user. Valid values: enable, disable.
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.
Vdoms List<Pulumiverse.Fortios.System.Snmp.Inputs.UserVdom>
SNMP access control VDOMs. The structure of vdoms block is documented below.
AuthProto string
Authentication protocol.
AuthPwd string
Password for authentication protocol.
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.
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.
HaDirect string
Enable/disable direct management of HA cluster members. Valid values: enable, disable.
MibView string
SNMP access control MIB view.
Name Changes to this property will trigger replacement. string
SNMP user name.
NotifyHosts string
SNMP managers to send notifications (traps) to.
NotifyHosts6 string
IPv6 SNMP managers to send notifications (traps) to.
PrivProto string
Privacy (encryption) protocol. Valid values: aes, des, aes256, aes256cisco.
PrivPwd string
Password for privacy (encryption) protocol.
Queries string
Enable/disable SNMP queries for this user. Valid values: enable, disable.
QueryPort int
SNMPv3 query port (default = 161).
SecurityLevel string
Security level for message authentication and encryption. Valid values: no-auth-no-priv, auth-no-priv, auth-priv.
SourceIp string
Source IP for SNMP trap.
SourceIpv6 string
Source IPv6 for SNMP trap.
Status string
Enable/disable this SNMP user. Valid values: enable, disable.
TrapLport int
SNMPv3 local trap port (default = 162).
TrapRport int
SNMPv3 trap remote port (default = 162).
TrapStatus string
Enable/disable traps for this SNMP user. Valid values: enable, disable.
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.
Vdoms []UserVdomArgs
SNMP access control VDOMs. The structure of vdoms block is documented below.
authProto String
Authentication protocol.
authPwd String
Password for authentication protocol.
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.
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.
haDirect String
Enable/disable direct management of HA cluster members. Valid values: enable, disable.
mibView String
SNMP access control MIB view.
name Changes to this property will trigger replacement. String
SNMP user name.
notifyHosts String
SNMP managers to send notifications (traps) to.
notifyHosts6 String
IPv6 SNMP managers to send notifications (traps) to.
privProto String
Privacy (encryption) protocol. Valid values: aes, des, aes256, aes256cisco.
privPwd String
Password for privacy (encryption) protocol.
queries String
Enable/disable SNMP queries for this user. Valid values: enable, disable.
queryPort Integer
SNMPv3 query port (default = 161).
securityLevel String
Security level for message authentication and encryption. Valid values: no-auth-no-priv, auth-no-priv, auth-priv.
sourceIp String
Source IP for SNMP trap.
sourceIpv6 String
Source IPv6 for SNMP trap.
status String
Enable/disable this SNMP user. Valid values: enable, disable.
trapLport Integer
SNMPv3 local trap port (default = 162).
trapRport Integer
SNMPv3 trap remote port (default = 162).
trapStatus String
Enable/disable traps for this SNMP user. Valid values: enable, disable.
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.
vdoms List<UserVdom>
SNMP access control VDOMs. The structure of vdoms block is documented below.
authProto string
Authentication protocol.
authPwd string
Password for authentication protocol.
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.
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.
haDirect string
Enable/disable direct management of HA cluster members. Valid values: enable, disable.
mibView string
SNMP access control MIB view.
name Changes to this property will trigger replacement. string
SNMP user name.
notifyHosts string
SNMP managers to send notifications (traps) to.
notifyHosts6 string
IPv6 SNMP managers to send notifications (traps) to.
privProto string
Privacy (encryption) protocol. Valid values: aes, des, aes256, aes256cisco.
privPwd string
Password for privacy (encryption) protocol.
queries string
Enable/disable SNMP queries for this user. Valid values: enable, disable.
queryPort number
SNMPv3 query port (default = 161).
securityLevel string
Security level for message authentication and encryption. Valid values: no-auth-no-priv, auth-no-priv, auth-priv.
sourceIp string
Source IP for SNMP trap.
sourceIpv6 string
Source IPv6 for SNMP trap.
status string
Enable/disable this SNMP user. Valid values: enable, disable.
trapLport number
SNMPv3 local trap port (default = 162).
trapRport number
SNMPv3 trap remote port (default = 162).
trapStatus string
Enable/disable traps for this SNMP user. Valid values: enable, disable.
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.
vdoms UserVdom[]
SNMP access control VDOMs. The structure of vdoms block is documented below.
auth_proto str
Authentication protocol.
auth_pwd str
Password for authentication protocol.
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.
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.
ha_direct str
Enable/disable direct management of HA cluster members. Valid values: enable, disable.
mib_view str
SNMP access control MIB view.
name Changes to this property will trigger replacement. str
SNMP user name.
notify_hosts str
SNMP managers to send notifications (traps) to.
notify_hosts6 str
IPv6 SNMP managers to send notifications (traps) to.
priv_proto str
Privacy (encryption) protocol. Valid values: aes, des, aes256, aes256cisco.
priv_pwd str
Password for privacy (encryption) protocol.
queries str
Enable/disable SNMP queries for this user. Valid values: enable, disable.
query_port int
SNMPv3 query port (default = 161).
security_level str
Security level for message authentication and encryption. Valid values: no-auth-no-priv, auth-no-priv, auth-priv.
source_ip str
Source IP for SNMP trap.
source_ipv6 str
Source IPv6 for SNMP trap.
status str
Enable/disable this SNMP user. Valid values: enable, disable.
trap_lport int
SNMPv3 local trap port (default = 162).
trap_rport int
SNMPv3 trap remote port (default = 162).
trap_status str
Enable/disable traps for this SNMP user. Valid values: enable, disable.
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.
vdoms Sequence[UserVdomArgs]
SNMP access control VDOMs. The structure of vdoms block is documented below.
authProto String
Authentication protocol.
authPwd String
Password for authentication protocol.
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.
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.
haDirect String
Enable/disable direct management of HA cluster members. Valid values: enable, disable.
mibView String
SNMP access control MIB view.
name Changes to this property will trigger replacement. String
SNMP user name.
notifyHosts String
SNMP managers to send notifications (traps) to.
notifyHosts6 String
IPv6 SNMP managers to send notifications (traps) to.
privProto String
Privacy (encryption) protocol. Valid values: aes, des, aes256, aes256cisco.
privPwd String
Password for privacy (encryption) protocol.
queries String
Enable/disable SNMP queries for this user. Valid values: enable, disable.
queryPort Number
SNMPv3 query port (default = 161).
securityLevel String
Security level for message authentication and encryption. Valid values: no-auth-no-priv, auth-no-priv, auth-priv.
sourceIp String
Source IP for SNMP trap.
sourceIpv6 String
Source IPv6 for SNMP trap.
status String
Enable/disable this SNMP user. Valid values: enable, disable.
trapLport Number
SNMPv3 local trap port (default = 162).
trapRport Number
SNMPv3 trap remote port (default = 162).
trapStatus String
Enable/disable traps for this SNMP user. Valid values: enable, disable.
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.
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 User 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 User Resource

Get an existing User 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?: UserState, opts?: CustomResourceOptions): User
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_proto: Optional[str] = None,
        auth_pwd: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        events: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        ha_direct: Optional[str] = None,
        mib_view: Optional[str] = None,
        name: Optional[str] = None,
        notify_hosts: Optional[str] = None,
        notify_hosts6: Optional[str] = None,
        priv_proto: Optional[str] = None,
        priv_pwd: Optional[str] = None,
        queries: Optional[str] = None,
        query_port: Optional[int] = None,
        security_level: Optional[str] = None,
        source_ip: Optional[str] = None,
        source_ipv6: Optional[str] = None,
        status: Optional[str] = None,
        trap_lport: Optional[int] = None,
        trap_rport: Optional[int] = None,
        trap_status: Optional[str] = None,
        vdomparam: Optional[str] = None,
        vdoms: Optional[Sequence[UserVdomArgs]] = None) -> User
func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
resources:  _:    type: fortios:system/snmp/user:User    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:
AuthProto string
Authentication protocol.
AuthPwd string
Password for authentication protocol.
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.
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.
HaDirect string
Enable/disable direct management of HA cluster members. Valid values: enable, disable.
MibView string
SNMP access control MIB view.
Name Changes to this property will trigger replacement. string
SNMP user name.
NotifyHosts string
SNMP managers to send notifications (traps) to.
NotifyHosts6 string
IPv6 SNMP managers to send notifications (traps) to.
PrivProto string
Privacy (encryption) protocol. Valid values: aes, des, aes256, aes256cisco.
PrivPwd string
Password for privacy (encryption) protocol.
Queries string
Enable/disable SNMP queries for this user. Valid values: enable, disable.
QueryPort int
SNMPv3 query port (default = 161).
SecurityLevel string
Security level for message authentication and encryption. Valid values: no-auth-no-priv, auth-no-priv, auth-priv.
SourceIp string
Source IP for SNMP trap.
SourceIpv6 string
Source IPv6 for SNMP trap.
Status string
Enable/disable this SNMP user. Valid values: enable, disable.
TrapLport int
SNMPv3 local trap port (default = 162).
TrapRport int
SNMPv3 trap remote port (default = 162).
TrapStatus string
Enable/disable traps for this SNMP user. Valid values: enable, disable.
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.
Vdoms List<Pulumiverse.Fortios.System.Snmp.Inputs.UserVdom>
SNMP access control VDOMs. The structure of vdoms block is documented below.
AuthProto string
Authentication protocol.
AuthPwd string
Password for authentication protocol.
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.
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.
HaDirect string
Enable/disable direct management of HA cluster members. Valid values: enable, disable.
MibView string
SNMP access control MIB view.
Name Changes to this property will trigger replacement. string
SNMP user name.
NotifyHosts string
SNMP managers to send notifications (traps) to.
NotifyHosts6 string
IPv6 SNMP managers to send notifications (traps) to.
PrivProto string
Privacy (encryption) protocol. Valid values: aes, des, aes256, aes256cisco.
PrivPwd string
Password for privacy (encryption) protocol.
Queries string
Enable/disable SNMP queries for this user. Valid values: enable, disable.
QueryPort int
SNMPv3 query port (default = 161).
SecurityLevel string
Security level for message authentication and encryption. Valid values: no-auth-no-priv, auth-no-priv, auth-priv.
SourceIp string
Source IP for SNMP trap.
SourceIpv6 string
Source IPv6 for SNMP trap.
Status string
Enable/disable this SNMP user. Valid values: enable, disable.
TrapLport int
SNMPv3 local trap port (default = 162).
TrapRport int
SNMPv3 trap remote port (default = 162).
TrapStatus string
Enable/disable traps for this SNMP user. Valid values: enable, disable.
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.
Vdoms []UserVdomArgs
SNMP access control VDOMs. The structure of vdoms block is documented below.
authProto String
Authentication protocol.
authPwd String
Password for authentication protocol.
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.
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.
haDirect String
Enable/disable direct management of HA cluster members. Valid values: enable, disable.
mibView String
SNMP access control MIB view.
name Changes to this property will trigger replacement. String
SNMP user name.
notifyHosts String
SNMP managers to send notifications (traps) to.
notifyHosts6 String
IPv6 SNMP managers to send notifications (traps) to.
privProto String
Privacy (encryption) protocol. Valid values: aes, des, aes256, aes256cisco.
privPwd String
Password for privacy (encryption) protocol.
queries String
Enable/disable SNMP queries for this user. Valid values: enable, disable.
queryPort Integer
SNMPv3 query port (default = 161).
securityLevel String
Security level for message authentication and encryption. Valid values: no-auth-no-priv, auth-no-priv, auth-priv.
sourceIp String
Source IP for SNMP trap.
sourceIpv6 String
Source IPv6 for SNMP trap.
status String
Enable/disable this SNMP user. Valid values: enable, disable.
trapLport Integer
SNMPv3 local trap port (default = 162).
trapRport Integer
SNMPv3 trap remote port (default = 162).
trapStatus String
Enable/disable traps for this SNMP user. Valid values: enable, disable.
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.
vdoms List<UserVdom>
SNMP access control VDOMs. The structure of vdoms block is documented below.
authProto string
Authentication protocol.
authPwd string
Password for authentication protocol.
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.
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.
haDirect string
Enable/disable direct management of HA cluster members. Valid values: enable, disable.
mibView string
SNMP access control MIB view.
name Changes to this property will trigger replacement. string
SNMP user name.
notifyHosts string
SNMP managers to send notifications (traps) to.
notifyHosts6 string
IPv6 SNMP managers to send notifications (traps) to.
privProto string
Privacy (encryption) protocol. Valid values: aes, des, aes256, aes256cisco.
privPwd string
Password for privacy (encryption) protocol.
queries string
Enable/disable SNMP queries for this user. Valid values: enable, disable.
queryPort number
SNMPv3 query port (default = 161).
securityLevel string
Security level for message authentication and encryption. Valid values: no-auth-no-priv, auth-no-priv, auth-priv.
sourceIp string
Source IP for SNMP trap.
sourceIpv6 string
Source IPv6 for SNMP trap.
status string
Enable/disable this SNMP user. Valid values: enable, disable.
trapLport number
SNMPv3 local trap port (default = 162).
trapRport number
SNMPv3 trap remote port (default = 162).
trapStatus string
Enable/disable traps for this SNMP user. Valid values: enable, disable.
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.
vdoms UserVdom[]
SNMP access control VDOMs. The structure of vdoms block is documented below.
auth_proto str
Authentication protocol.
auth_pwd str
Password for authentication protocol.
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.
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.
ha_direct str
Enable/disable direct management of HA cluster members. Valid values: enable, disable.
mib_view str
SNMP access control MIB view.
name Changes to this property will trigger replacement. str
SNMP user name.
notify_hosts str
SNMP managers to send notifications (traps) to.
notify_hosts6 str
IPv6 SNMP managers to send notifications (traps) to.
priv_proto str
Privacy (encryption) protocol. Valid values: aes, des, aes256, aes256cisco.
priv_pwd str
Password for privacy (encryption) protocol.
queries str
Enable/disable SNMP queries for this user. Valid values: enable, disable.
query_port int
SNMPv3 query port (default = 161).
security_level str
Security level for message authentication and encryption. Valid values: no-auth-no-priv, auth-no-priv, auth-priv.
source_ip str
Source IP for SNMP trap.
source_ipv6 str
Source IPv6 for SNMP trap.
status str
Enable/disable this SNMP user. Valid values: enable, disable.
trap_lport int
SNMPv3 local trap port (default = 162).
trap_rport int
SNMPv3 trap remote port (default = 162).
trap_status str
Enable/disable traps for this SNMP user. Valid values: enable, disable.
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.
vdoms Sequence[UserVdomArgs]
SNMP access control VDOMs. The structure of vdoms block is documented below.
authProto String
Authentication protocol.
authPwd String
Password for authentication protocol.
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.
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.
haDirect String
Enable/disable direct management of HA cluster members. Valid values: enable, disable.
mibView String
SNMP access control MIB view.
name Changes to this property will trigger replacement. String
SNMP user name.
notifyHosts String
SNMP managers to send notifications (traps) to.
notifyHosts6 String
IPv6 SNMP managers to send notifications (traps) to.
privProto String
Privacy (encryption) protocol. Valid values: aes, des, aes256, aes256cisco.
privPwd String
Password for privacy (encryption) protocol.
queries String
Enable/disable SNMP queries for this user. Valid values: enable, disable.
queryPort Number
SNMPv3 query port (default = 161).
securityLevel String
Security level for message authentication and encryption. Valid values: no-auth-no-priv, auth-no-priv, auth-priv.
sourceIp String
Source IP for SNMP trap.
sourceIpv6 String
Source IPv6 for SNMP trap.
status String
Enable/disable this SNMP user. Valid values: enable, disable.
trapLport Number
SNMPv3 local trap port (default = 162).
trapRport Number
SNMPv3 trap remote port (default = 162).
trapStatus String
Enable/disable traps for this SNMP user. Valid values: enable, disable.
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.
vdoms List<Property Map>
SNMP access control VDOMs. The structure of vdoms block is documented below.

Supporting Types

UserVdom
, UserVdomArgs

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 User can be imported using any of these accepted formats:

$ pulumi import fortios:system/snmp/user:User labelname {{name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:system/snmp/user:User labelname {{name}}
Copy

$ unset “FORTIOS_IMPORT_TABLE”

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

Package Details

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