Docs Packages
  1. Packages
  2. F5 BIG-IP
  3. API Docs
  4. sys
  5. SnmpTraps
f5 BIG-IP v3.17.0 published on Thursday, Mar 28, 2024 by Pulumi
pulumi/pulumi-f5bigip

f5bigip.sys.SnmpTraps

Explore with Pulumi AI

f5bigip logo
f5 BIG-IP v3.17.0 published on Thursday, Mar 28, 2024 by Pulumi
pulumi/pulumi-f5bigip

    f5bigip.sys.SnmpTraps provides details bout how to enable snmp_traps resource on BIG-IP

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as f5bigip from "@pulumi/f5bigip";

const snmpTraps = new f5bigip.sys.SnmpTraps("snmpTraps", {
    community: "f5community",
    description: "Setup snmp traps",
    host: "195.10.10.1",
    name: "snmptraps",
    port: 111,
});

    import pulumi
import pulumi_f5bigip as f5bigip

snmp_traps = f5bigip.sys.SnmpTraps("snmpTraps",
    community="f5community",
    description="Setup snmp traps",
    host="195.10.10.1",
    name="snmptraps",
    port=111)

    package main

import (
	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip/sys"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sys.NewSnmpTraps(ctx, "snmpTraps", &sys.SnmpTrapsArgs{
			Community:   pulumi.String("f5community"),
			Description: pulumi.String("Setup snmp traps"),
			Host:        pulumi.String("195.10.10.1"),
			Name:        pulumi.String("snmptraps"),
			Port:        pulumi.Int(111),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using F5BigIP = Pulumi.F5BigIP;

return await Deployment.RunAsync(() => 
{
    var snmpTraps = new F5BigIP.Sys.SnmpTraps("snmpTraps", new()
    {
        Community = "f5community",
        Description = "Setup snmp traps",
        Host = "195.10.10.1",
        Name = "snmptraps",
        Port = 111,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.f5bigip.sys.SnmpTraps;
import com.pulumi.f5bigip.sys.SnmpTrapsArgs;
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 snmpTraps = new SnmpTraps("snmpTraps", SnmpTrapsArgs.builder()        
            .community("f5community")
            .description("Setup snmp traps")
            .host("195.10.10.1")
            .name("snmptraps")
            .port(111)
            .build());

    }
}

    resources:
  snmpTraps:
    type: f5bigip:sys:SnmpTraps
    properties:
      community: f5community
      description: Setup snmp traps
      host: 195.10.10.1
      name: snmptraps
      port: 111

    Create SnmpTraps Resource

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

    Constructor syntax

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

@overload
def SnmpTraps(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              auth_passwordencrypted: Optional[str] = None,
              auth_protocol: Optional[str] = None,
              community: Optional[str] = None,
              description: Optional[str] = None,
              engine_id: Optional[str] = None,
              host: Optional[str] = None,
              name: Optional[str] = None,
              port: Optional[int] = None,
              privacy_password: Optional[str] = None,
              privacy_password_encrypted: Optional[str] = None,
              privacy_protocol: Optional[str] = None,
              security_level: Optional[str] = None,
              security_name: Optional[str] = None,
              version: Optional[str] = None)
    func NewSnmpTraps(ctx *Context, name string, args *SnmpTrapsArgs, opts ...ResourceOption) (*SnmpTraps, error)
    public SnmpTraps(string name, SnmpTrapsArgs? args = null, CustomResourceOptions? opts = null)
    public SnmpTraps(String name, SnmpTrapsArgs args)
public SnmpTraps(String name, SnmpTrapsArgs args, CustomResourceOptions options)

    type: f5bigip:sys:SnmpTraps
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 SnmpTrapsArgs
    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 SnmpTrapsArgs
    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 SnmpTrapsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SnmpTrapsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SnmpTrapsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var snmpTrapsResource = new F5BigIP.Sys.SnmpTraps("snmpTrapsResource", new()
{
    AuthPasswordencrypted = "string",
    AuthProtocol = "string",
    Community = "string",
    Description = "string",
    EngineId = "string",
    Host = "string",
    Name = "string",
    Port = 0,
    PrivacyPassword = "string",
    PrivacyPasswordEncrypted = "string",
    PrivacyProtocol = "string",
    SecurityLevel = "string",
    SecurityName = "string",
    Version = "string",
});

    example, err := sys.NewSnmpTraps(ctx, "snmpTrapsResource", &sys.SnmpTrapsArgs{
	AuthPasswordencrypted:    pulumi.String("string"),
	AuthProtocol:             pulumi.String("string"),
	Community:                pulumi.String("string"),
	Description:              pulumi.String("string"),
	EngineId:                 pulumi.String("string"),
	Host:                     pulumi.String("string"),
	Name:                     pulumi.String("string"),
	Port:                     pulumi.Int(0),
	PrivacyPassword:          pulumi.String("string"),
	PrivacyPasswordEncrypted: pulumi.String("string"),
	PrivacyProtocol:          pulumi.String("string"),
	SecurityLevel:            pulumi.String("string"),
	SecurityName:             pulumi.String("string"),
	Version:                  pulumi.String("string"),
})

    var snmpTrapsResource = new SnmpTraps("snmpTrapsResource", SnmpTrapsArgs.builder()        
    .authPasswordencrypted("string")
    .authProtocol("string")
    .community("string")
    .description("string")
    .engineId("string")
    .host("string")
    .name("string")
    .port(0)
    .privacyPassword("string")
    .privacyPasswordEncrypted("string")
    .privacyProtocol("string")
    .securityLevel("string")
    .securityName("string")
    .version("string")
    .build());

    snmp_traps_resource = f5bigip.sys.SnmpTraps("snmpTrapsResource",
    auth_passwordencrypted="string",
    auth_protocol="string",
    community="string",
    description="string",
    engine_id="string",
    host="string",
    name="string",
    port=0,
    privacy_password="string",
    privacy_password_encrypted="string",
    privacy_protocol="string",
    security_level="string",
    security_name="string",
    version="string")

    const snmpTrapsResource = new f5bigip.sys.SnmpTraps("snmpTrapsResource", {
    authPasswordencrypted: "string",
    authProtocol: "string",
    community: "string",
    description: "string",
    engineId: "string",
    host: "string",
    name: "string",
    port: 0,
    privacyPassword: "string",
    privacyPasswordEncrypted: "string",
    privacyProtocol: "string",
    securityLevel: "string",
    securityName: "string",
    version: "string",
});

    type: f5bigip:sys:SnmpTraps
properties:
    authPasswordencrypted: string
    authProtocol: string
    community: string
    description: string
    engineId: string
    host: string
    name: string
    port: 0
    privacyPassword: string
    privacyPasswordEncrypted: string
    privacyProtocol: string
    securityLevel: string
    securityName: string
    version: string

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

    AuthPasswordencrypted string
    Encrypted password
    AuthProtocol string
    Specifies the protocol used to authenticate the user.
    Community string
    Specifies the community string used for this trap.
    Description string
    The port that the trap will be sent to.
    EngineId string
    Specifies the authoritative security engine for SNMPv3.
    Host string
    The host the trap will be sent to.
    Name string
    Name of the snmp trap.
    Port int
    User defined description.
    PrivacyPassword string
    Specifies the clear text password used to encrypt traffic. This field will not be displayed.
    PrivacyPasswordEncrypted string
    Specifies the encrypted password used to encrypt traffic.
    PrivacyProtocol string
    Specifies the protocol used to encrypt traffic.
    SecurityLevel string
    Specifies whether or not traffic is encrypted and whether or not authentication is required.
    SecurityName string
    Security name used in conjunction with SNMPv3.
    Version string
    SNMP version used for sending the trap.
    AuthPasswordencrypted string
    Encrypted password
    AuthProtocol string
    Specifies the protocol used to authenticate the user.
    Community string
    Specifies the community string used for this trap.
    Description string
    The port that the trap will be sent to.
    EngineId string
    Specifies the authoritative security engine for SNMPv3.
    Host string
    The host the trap will be sent to.
    Name string
    Name of the snmp trap.
    Port int
    User defined description.
    PrivacyPassword string
    Specifies the clear text password used to encrypt traffic. This field will not be displayed.
    PrivacyPasswordEncrypted string
    Specifies the encrypted password used to encrypt traffic.
    PrivacyProtocol string
    Specifies the protocol used to encrypt traffic.
    SecurityLevel string
    Specifies whether or not traffic is encrypted and whether or not authentication is required.
    SecurityName string
    Security name used in conjunction with SNMPv3.
    Version string
    SNMP version used for sending the trap.
    authPasswordencrypted String
    Encrypted password
    authProtocol String
    Specifies the protocol used to authenticate the user.
    community String
    Specifies the community string used for this trap.
    description String
    The port that the trap will be sent to.
    engineId String
    Specifies the authoritative security engine for SNMPv3.
    host String
    The host the trap will be sent to.
    name String
    Name of the snmp trap.
    port Integer
    User defined description.
    privacyPassword String
    Specifies the clear text password used to encrypt traffic. This field will not be displayed.
    privacyPasswordEncrypted String
    Specifies the encrypted password used to encrypt traffic.
    privacyProtocol String
    Specifies the protocol used to encrypt traffic.
    securityLevel String
    Specifies whether or not traffic is encrypted and whether or not authentication is required.
    securityName String
    Security name used in conjunction with SNMPv3.
    version String
    SNMP version used for sending the trap.
    authPasswordencrypted string
    Encrypted password
    authProtocol string
    Specifies the protocol used to authenticate the user.
    community string
    Specifies the community string used for this trap.
    description string
    The port that the trap will be sent to.
    engineId string
    Specifies the authoritative security engine for SNMPv3.
    host string
    The host the trap will be sent to.
    name string
    Name of the snmp trap.
    port number
    User defined description.
    privacyPassword string
    Specifies the clear text password used to encrypt traffic. This field will not be displayed.
    privacyPasswordEncrypted string
    Specifies the encrypted password used to encrypt traffic.
    privacyProtocol string
    Specifies the protocol used to encrypt traffic.
    securityLevel string
    Specifies whether or not traffic is encrypted and whether or not authentication is required.
    securityName string
    Security name used in conjunction with SNMPv3.
    version string
    SNMP version used for sending the trap.
    auth_passwordencrypted str
    Encrypted password
    auth_protocol str
    Specifies the protocol used to authenticate the user.
    community str
    Specifies the community string used for this trap.
    description str
    The port that the trap will be sent to.
    engine_id str
    Specifies the authoritative security engine for SNMPv3.
    host str
    The host the trap will be sent to.
    name str
    Name of the snmp trap.
    port int
    User defined description.
    privacy_password str
    Specifies the clear text password used to encrypt traffic. This field will not be displayed.
    privacy_password_encrypted str
    Specifies the encrypted password used to encrypt traffic.
    privacy_protocol str
    Specifies the protocol used to encrypt traffic.
    security_level str
    Specifies whether or not traffic is encrypted and whether or not authentication is required.
    security_name str
    Security name used in conjunction with SNMPv3.
    version str
    SNMP version used for sending the trap.
    authPasswordencrypted String
    Encrypted password
    authProtocol String
    Specifies the protocol used to authenticate the user.
    community String
    Specifies the community string used for this trap.
    description String
    The port that the trap will be sent to.
    engineId String
    Specifies the authoritative security engine for SNMPv3.
    host String
    The host the trap will be sent to.
    name String
    Name of the snmp trap.
    port Number
    User defined description.
    privacyPassword String
    Specifies the clear text password used to encrypt traffic. This field will not be displayed.
    privacyPasswordEncrypted String
    Specifies the encrypted password used to encrypt traffic.
    privacyProtocol String
    Specifies the protocol used to encrypt traffic.
    securityLevel String
    Specifies whether or not traffic is encrypted and whether or not authentication is required.
    securityName String
    Security name used in conjunction with SNMPv3.
    version String
    SNMP version used for sending the trap.

    Outputs

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

    Get an existing SnmpTraps 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?: SnmpTrapsState, opts?: CustomResourceOptions): SnmpTraps
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_passwordencrypted: Optional[str] = None,
        auth_protocol: Optional[str] = None,
        community: Optional[str] = None,
        description: Optional[str] = None,
        engine_id: Optional[str] = None,
        host: Optional[str] = None,
        name: Optional[str] = None,
        port: Optional[int] = None,
        privacy_password: Optional[str] = None,
        privacy_password_encrypted: Optional[str] = None,
        privacy_protocol: Optional[str] = None,
        security_level: Optional[str] = None,
        security_name: Optional[str] = None,
        version: Optional[str] = None) -> SnmpTraps
    func GetSnmpTraps(ctx *Context, name string, id IDInput, state *SnmpTrapsState, opts ...ResourceOption) (*SnmpTraps, error)
    public static SnmpTraps Get(string name, Input<string> id, SnmpTrapsState? state, CustomResourceOptions? opts = null)
    public static SnmpTraps get(String name, Output<String> id, SnmpTrapsState 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:
    AuthPasswordencrypted string
    Encrypted password
    AuthProtocol string
    Specifies the protocol used to authenticate the user.
    Community string
    Specifies the community string used for this trap.
    Description string
    The port that the trap will be sent to.
    EngineId string
    Specifies the authoritative security engine for SNMPv3.
    Host string
    The host the trap will be sent to.
    Name string
    Name of the snmp trap.
    Port int
    User defined description.
    PrivacyPassword string
    Specifies the clear text password used to encrypt traffic. This field will not be displayed.
    PrivacyPasswordEncrypted string
    Specifies the encrypted password used to encrypt traffic.
    PrivacyProtocol string
    Specifies the protocol used to encrypt traffic.
    SecurityLevel string
    Specifies whether or not traffic is encrypted and whether or not authentication is required.
    SecurityName string
    Security name used in conjunction with SNMPv3.
    Version string
    SNMP version used for sending the trap.
    AuthPasswordencrypted string
    Encrypted password
    AuthProtocol string
    Specifies the protocol used to authenticate the user.
    Community string
    Specifies the community string used for this trap.
    Description string
    The port that the trap will be sent to.
    EngineId string
    Specifies the authoritative security engine for SNMPv3.
    Host string
    The host the trap will be sent to.
    Name string
    Name of the snmp trap.
    Port int
    User defined description.
    PrivacyPassword string
    Specifies the clear text password used to encrypt traffic. This field will not be displayed.
    PrivacyPasswordEncrypted string
    Specifies the encrypted password used to encrypt traffic.
    PrivacyProtocol string
    Specifies the protocol used to encrypt traffic.
    SecurityLevel string
    Specifies whether or not traffic is encrypted and whether or not authentication is required.
    SecurityName string
    Security name used in conjunction with SNMPv3.
    Version string
    SNMP version used for sending the trap.
    authPasswordencrypted String
    Encrypted password
    authProtocol String
    Specifies the protocol used to authenticate the user.
    community String
    Specifies the community string used for this trap.
    description String
    The port that the trap will be sent to.
    engineId String
    Specifies the authoritative security engine for SNMPv3.
    host String
    The host the trap will be sent to.
    name String
    Name of the snmp trap.
    port Integer
    User defined description.
    privacyPassword String
    Specifies the clear text password used to encrypt traffic. This field will not be displayed.
    privacyPasswordEncrypted String
    Specifies the encrypted password used to encrypt traffic.
    privacyProtocol String
    Specifies the protocol used to encrypt traffic.
    securityLevel String
    Specifies whether or not traffic is encrypted and whether or not authentication is required.
    securityName String
    Security name used in conjunction with SNMPv3.
    version String
    SNMP version used for sending the trap.
    authPasswordencrypted string
    Encrypted password
    authProtocol string
    Specifies the protocol used to authenticate the user.
    community string
    Specifies the community string used for this trap.
    description string
    The port that the trap will be sent to.
    engineId string
    Specifies the authoritative security engine for SNMPv3.
    host string
    The host the trap will be sent to.
    name string
    Name of the snmp trap.
    port number
    User defined description.
    privacyPassword string
    Specifies the clear text password used to encrypt traffic. This field will not be displayed.
    privacyPasswordEncrypted string
    Specifies the encrypted password used to encrypt traffic.
    privacyProtocol string
    Specifies the protocol used to encrypt traffic.
    securityLevel string
    Specifies whether or not traffic is encrypted and whether or not authentication is required.
    securityName string
    Security name used in conjunction with SNMPv3.
    version string
    SNMP version used for sending the trap.
    auth_passwordencrypted str
    Encrypted password
    auth_protocol str
    Specifies the protocol used to authenticate the user.
    community str
    Specifies the community string used for this trap.
    description str
    The port that the trap will be sent to.
    engine_id str
    Specifies the authoritative security engine for SNMPv3.
    host str
    The host the trap will be sent to.
    name str
    Name of the snmp trap.
    port int
    User defined description.
    privacy_password str
    Specifies the clear text password used to encrypt traffic. This field will not be displayed.
    privacy_password_encrypted str
    Specifies the encrypted password used to encrypt traffic.
    privacy_protocol str
    Specifies the protocol used to encrypt traffic.
    security_level str
    Specifies whether or not traffic is encrypted and whether or not authentication is required.
    security_name str
    Security name used in conjunction with SNMPv3.
    version str
    SNMP version used for sending the trap.
    authPasswordencrypted String
    Encrypted password
    authProtocol String
    Specifies the protocol used to authenticate the user.
    community String
    Specifies the community string used for this trap.
    description String
    The port that the trap will be sent to.
    engineId String
    Specifies the authoritative security engine for SNMPv3.
    host String
    The host the trap will be sent to.
    name String
    Name of the snmp trap.
    port Number
    User defined description.
    privacyPassword String
    Specifies the clear text password used to encrypt traffic. This field will not be displayed.
    privacyPasswordEncrypted String
    Specifies the encrypted password used to encrypt traffic.
    privacyProtocol String
    Specifies the protocol used to encrypt traffic.
    securityLevel String
    Specifies whether or not traffic is encrypted and whether or not authentication is required.
    securityName String
    Security name used in conjunction with SNMPv3.
    version String
    SNMP version used for sending the trap.

    Package Details

    Repository
    f5 BIG-IP pulumi/pulumi-f5bigip
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the bigip Terraform Provider.
    f5bigip logo
    f5 BIG-IP v3.17.0 published on Thursday, Mar 28, 2024 by Pulumi
    pulumi/pulumi-f5bigip