fortios.switchcontroller.Snmpuser
Explore with Pulumi AI
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
The Snmpuser resource accepts the following input properties:
- Auth
Proto string - Authentication protocol.
- Auth
Pwd string - Password for authentication protocol.
- Name string
- SNMP user name.
- Priv
Proto string - Privacy (encryption) protocol.
- Priv
Pwd string - Password for privacy (encryption) protocol.
- Queries string
- Enable/disable SNMP queries for this user. Valid values:
disable
,enable
. - Query
Port int - SNMPv3 query port (default = 161).
- Security
Level 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 string - Authentication protocol.
- Auth
Pwd string - Password for authentication protocol.
- Name string
- SNMP user name.
- Priv
Proto string - Privacy (encryption) protocol.
- Priv
Pwd string - Password for privacy (encryption) protocol.
- Queries string
- Enable/disable SNMP queries for this user. Valid values:
disable
,enable
. - Query
Port int - SNMPv3 query port (default = 161).
- Security
Level 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 String - Authentication protocol.
- auth
Pwd String - Password for authentication protocol.
- name String
- SNMP user name.
- priv
Proto String - Privacy (encryption) protocol.
- priv
Pwd String - Password for privacy (encryption) protocol.
- queries String
- Enable/disable SNMP queries for this user. Valid values:
disable
,enable
. - query
Port Integer - SNMPv3 query port (default = 161).
- security
Level 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 string - Authentication protocol.
- auth
Pwd string - Password for authentication protocol.
- name string
- SNMP user name.
- priv
Proto string - Privacy (encryption) protocol.
- priv
Pwd string - Password for privacy (encryption) protocol.
- queries string
- Enable/disable SNMP queries for this user. Valid values:
disable
,enable
. - query
Port number - SNMPv3 query port (default = 161).
- security
Level 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.
- auth
Proto String - Authentication protocol.
- auth
Pwd String - Password for authentication protocol.
- name String
- SNMP user name.
- priv
Proto String - Privacy (encryption) protocol.
- priv
Pwd String - Password for privacy (encryption) protocol.
- queries String
- Enable/disable SNMP queries for this user. Valid values:
disable
,enable
. - query
Port Number - SNMPv3 query port (default = 161).
- security
Level 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.
- Auth
Proto string - Authentication protocol.
- Auth
Pwd string - Password for authentication protocol.
- Name string
- SNMP user name.
- Priv
Proto string - Privacy (encryption) protocol.
- Priv
Pwd string - Password for privacy (encryption) protocol.
- Queries string
- Enable/disable SNMP queries for this user. Valid values:
disable
,enable
. - Query
Port int - SNMPv3 query port (default = 161).
- Security
Level 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 string - Authentication protocol.
- Auth
Pwd string - Password for authentication protocol.
- Name string
- SNMP user name.
- Priv
Proto string - Privacy (encryption) protocol.
- Priv
Pwd string - Password for privacy (encryption) protocol.
- Queries string
- Enable/disable SNMP queries for this user. Valid values:
disable
,enable
. - Query
Port int - SNMPv3 query port (default = 161).
- Security
Level 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 String - Authentication protocol.
- auth
Pwd String - Password for authentication protocol.
- name String
- SNMP user name.
- priv
Proto String - Privacy (encryption) protocol.
- priv
Pwd String - Password for privacy (encryption) protocol.
- queries String
- Enable/disable SNMP queries for this user. Valid values:
disable
,enable
. - query
Port Integer - SNMPv3 query port (default = 161).
- security
Level 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 string - Authentication protocol.
- auth
Pwd string - Password for authentication protocol.
- name string
- SNMP user name.
- priv
Proto string - Privacy (encryption) protocol.
- priv
Pwd string - Password for privacy (encryption) protocol.
- queries string
- Enable/disable SNMP queries for this user. Valid values:
disable
,enable
. - query
Port number - SNMPv3 query port (default = 161).
- security
Level 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.
- auth
Proto String - Authentication protocol.
- auth
Pwd String - Password for authentication protocol.
- name String
- SNMP user name.
- priv
Proto String - Privacy (encryption) protocol.
- priv
Pwd String - Password for privacy (encryption) protocol.
- queries String
- Enable/disable SNMP queries for this user. Valid values:
disable
,enable
. - query
Port Number - SNMPv3 query port (default = 161).
- security
Level 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.