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

fortios.switchcontroller.Snmpuser

Explore with Pulumi AI

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

    Configure FortiSwitch SNMP v3 users globally. Applies to FortiOS Version >= 6.2.4.

    Create Snmpuser Resource

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

    Constructor syntax

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

@overload
def Snmpuser(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             auth_proto: Optional[str] = None,
             auth_pwd: Optional[str] = None,
             name: 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,
             vdomparam: Optional[str] = None)
    func NewSnmpuser(ctx *Context, name string, args *SnmpuserArgs, opts ...ResourceOption) (*Snmpuser, error)
    public Snmpuser(string name, SnmpuserArgs? args = null, CustomResourceOptions? opts = null)
    public Snmpuser(String name, SnmpuserArgs args)
public Snmpuser(String name, SnmpuserArgs args, CustomResourceOptions options)

    type: fortios:switchcontroller:Snmpuser
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 SnmpuserArgs
    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 SnmpuserArgs
    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 SnmpuserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SnmpuserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SnmpuserArgs
    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 snmpuserResource = new Fortios.Switchcontroller.Snmpuser("snmpuserResource", new()
{
    AuthProto = "string",
    AuthPwd = "string",
    Name = "string",
    PrivProto = "string",
    PrivPwd = "string",
    Queries = "string",
    QueryPort = 0,
    SecurityLevel = "string",
    Vdomparam = "string",
});

    example, err := switchcontroller.NewSnmpuser(ctx, "snmpuserResource", &switchcontroller.SnmpuserArgs{
	AuthProto:     pulumi.String("string"),
	AuthPwd:       pulumi.String("string"),
	Name:          pulumi.String("string"),
	PrivProto:     pulumi.String("string"),
	PrivPwd:       pulumi.String("string"),
	Queries:       pulumi.String("string"),
	QueryPort:     pulumi.Int(0),
	SecurityLevel: pulumi.String("string"),
	Vdomparam:     pulumi.String("string"),
})

    var snmpuserResource = new Snmpuser("snmpuserResource", SnmpuserArgs.builder()
    .authProto("string")
    .authPwd("string")
    .name("string")
    .privProto("string")
    .privPwd("string")
    .queries("string")
    .queryPort(0)
    .securityLevel("string")
    .vdomparam("string")
    .build());

    snmpuser_resource = fortios.switchcontroller.Snmpuser("snmpuserResource",
    auth_proto="string",
    auth_pwd="string",
    name="string",
    priv_proto="string",
    priv_pwd="string",
    queries="string",
    query_port=0,
    security_level="string",
    vdomparam="string")

    const snmpuserResource = new fortios.switchcontroller.Snmpuser("snmpuserResource", {
    authProto: "string",
    authPwd: "string",
    name: "string",
    privProto: "string",
    privPwd: "string",
    queries: "string",
    queryPort: 0,
    securityLevel: "string",
    vdomparam: "string",
});

    type: fortios:switchcontroller:Snmpuser
properties:
    authProto: string
    authPwd: string
    name: string
    privProto: string
    privPwd: string
    queries: string
    queryPort: 0
    securityLevel: string
    vdomparam: string

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

    AuthProto string
    Authentication protocol.
    AuthPwd string
    Password for authentication protocol.
    Name string
    SNMP user name.
    PrivProto string
    Privacy (encryption) protocol.
    PrivPwd string
    Password for privacy (encryption) protocol.
    Queries string
    Enable/disable SNMP queries for this user. Valid values: disable, enable.
    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.
    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.
    AuthProto string
    Authentication protocol.
    AuthPwd string
    Password for authentication protocol.
    Name string
    SNMP user name.
    PrivProto string
    Privacy (encryption) protocol.
    PrivPwd string
    Password for privacy (encryption) protocol.
    Queries string
    Enable/disable SNMP queries for this user. Valid values: disable, enable.
    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.
    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.
    authProto String
    Authentication protocol.
    authPwd String
    Password for authentication protocol.
    name String
    SNMP user name.
    privProto String
    Privacy (encryption) protocol.
    privPwd String
    Password for privacy (encryption) protocol.
    queries String
    Enable/disable SNMP queries for this user. Valid values: disable, enable.
    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.
    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.
    authProto string
    Authentication protocol.
    authPwd string
    Password for authentication protocol.
    name string
    SNMP user name.
    privProto string
    Privacy (encryption) protocol.
    privPwd string
    Password for privacy (encryption) protocol.
    queries string
    Enable/disable SNMP queries for this user. Valid values: disable, enable.
    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.
    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.
    auth_proto str
    Authentication protocol.
    auth_pwd str
    Password for authentication protocol.
    name str
    SNMP user name.
    priv_proto str
    Privacy (encryption) protocol.
    priv_pwd str
    Password for privacy (encryption) protocol.
    queries str
    Enable/disable SNMP queries for this user. Valid values: disable, enable.
    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.
    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.
    authProto String
    Authentication protocol.
    authPwd String
    Password for authentication protocol.
    name String
    SNMP user name.
    privProto String
    Privacy (encryption) protocol.
    privPwd String
    Password for privacy (encryption) protocol.
    queries String
    Enable/disable SNMP queries for this user. Valid values: disable, enable.
    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.
    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.

    Outputs

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

    Get an existing Snmpuser 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?: SnmpuserState, opts?: CustomResourceOptions): Snmpuser
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_proto: Optional[str] = None,
        auth_pwd: Optional[str] = None,
        name: 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,
        vdomparam: Optional[str] = None) -> Snmpuser
    func GetSnmpuser(ctx *Context, name string, id IDInput, state *SnmpuserState, opts ...ResourceOption) (*Snmpuser, error)
    public static Snmpuser Get(string name, Input<string> id, SnmpuserState? state, CustomResourceOptions? opts = null)
    public static Snmpuser get(String name, Output<String> id, SnmpuserState 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.
    The following state arguments are supported:
    AuthProto string
    Authentication protocol.
    AuthPwd string
    Password for authentication protocol.
    Name string
    SNMP user name.
    PrivProto string
    Privacy (encryption) protocol.
    PrivPwd string
    Password for privacy (encryption) protocol.
    Queries string
    Enable/disable SNMP queries for this user. Valid values: disable, enable.
    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.
    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.
    AuthProto string
    Authentication protocol.
    AuthPwd string
    Password for authentication protocol.
    Name string
    SNMP user name.
    PrivProto string
    Privacy (encryption) protocol.
    PrivPwd string
    Password for privacy (encryption) protocol.
    Queries string
    Enable/disable SNMP queries for this user. Valid values: disable, enable.
    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.
    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.
    authProto String
    Authentication protocol.
    authPwd String
    Password for authentication protocol.
    name String
    SNMP user name.
    privProto String
    Privacy (encryption) protocol.
    privPwd String
    Password for privacy (encryption) protocol.
    queries String
    Enable/disable SNMP queries for this user. Valid values: disable, enable.
    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.
    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.
    authProto string
    Authentication protocol.
    authPwd string
    Password for authentication protocol.
    name string
    SNMP user name.
    privProto string
    Privacy (encryption) protocol.
    privPwd string
    Password for privacy (encryption) protocol.
    queries string
    Enable/disable SNMP queries for this user. Valid values: disable, enable.
    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.
    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.
    auth_proto str
    Authentication protocol.
    auth_pwd str
    Password for authentication protocol.
    name str
    SNMP user name.
    priv_proto str
    Privacy (encryption) protocol.
    priv_pwd str
    Password for privacy (encryption) protocol.
    queries str
    Enable/disable SNMP queries for this user. Valid values: disable, enable.
    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.
    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.
    authProto String
    Authentication protocol.
    authPwd String
    Password for authentication protocol.
    name String
    SNMP user name.
    privProto String
    Privacy (encryption) protocol.
    privPwd String
    Password for privacy (encryption) protocol.
    queries String
    Enable/disable SNMP queries for this user. Valid values: disable, enable.
    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.
    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.

    Import

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

    $ pulumi import fortios:switchcontroller/snmpuser:Snmpuser labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:switchcontroller/snmpuser:Snmpuser labelname {{name}}

    $ 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 logo
    Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios