Docs Packages
  1. Packages
  2. Cisco Meraki
  3. API Docs
  4. organizations
  5. Snmp
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

meraki.organizations.Snmp

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

    Example Usage

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

const example = new meraki.organizations.Snmp("example", {
    organizationId: "string",
    peerIps: ["123.123.123.1"],
    v2cEnabled: false,
    v3AuthMode: "SHA",
    v3AuthPass: "password",
    v3Enabled: true,
    v3PrivMode: "AES128",
    v3PrivPass: "password",
});
export const merakiOrganizationsSnmpExample = example;

    import pulumi
import pulumi_meraki as meraki

example = meraki.organizations.Snmp("example",
    organization_id="string",
    peer_ips=["123.123.123.1"],
    v2c_enabled=False,
    v3_auth_mode="SHA",
    v3_auth_pass="password",
    v3_enabled=True,
    v3_priv_mode="AES128",
    v3_priv_pass="password")
pulumi.export("merakiOrganizationsSnmpExample", example)

    package main

import (
	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := organizations.NewSnmp(ctx, "example", &organizations.SnmpArgs{
			OrganizationId: pulumi.String("string"),
			PeerIps: pulumi.StringArray{
				pulumi.String("123.123.123.1"),
			},
			V2cEnabled: pulumi.Bool(false),
			V3AuthMode: pulumi.String("SHA"),
			V3AuthPass: pulumi.String("password"),
			V3Enabled:  pulumi.Bool(true),
			V3PrivMode: pulumi.String("AES128"),
			V3PrivPass: pulumi.String("password"),
		})
		if err != nil {
			return err
		}
		ctx.Export("merakiOrganizationsSnmpExample", example)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Meraki.Organizations.Snmp("example", new()
    {
        OrganizationId = "string",
        PeerIps = new[]
        {
            "123.123.123.1",
        },
        V2cEnabled = false,
        V3AuthMode = "SHA",
        V3AuthPass = "password",
        V3Enabled = true,
        V3PrivMode = "AES128",
        V3PrivPass = "password",
    });

    return new Dictionary<string, object?>
    {
        ["merakiOrganizationsSnmpExample"] = example,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.organizations.Snmp;
import com.pulumi.meraki.organizations.SnmpArgs;
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 example = new Snmp("example", SnmpArgs.builder()
            .organizationId("string")
            .peerIps("123.123.123.1")
            .v2cEnabled(false)
            .v3AuthMode("SHA")
            .v3AuthPass("password")
            .v3Enabled(true)
            .v3PrivMode("AES128")
            .v3PrivPass("password")
            .build());

        ctx.export("merakiOrganizationsSnmpExample", example);
    }
}

    resources:
  example:
    type: meraki:organizations:Snmp
    properties:
      organizationId: string
      peerIps:
        - 123.123.123.1
      v2cEnabled: false
      v3AuthMode: SHA
      v3AuthPass: password
      v3Enabled: true
      v3PrivMode: AES128
      v3PrivPass: password
outputs:
  merakiOrganizationsSnmpExample: ${example}

    Create Snmp Resource

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

    Constructor syntax

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

@overload
def Snmp(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         organization_id: Optional[str] = None,
         peer_ips: Optional[Sequence[str]] = None,
         v2c_enabled: Optional[bool] = None,
         v3_auth_mode: Optional[str] = None,
         v3_auth_pass: Optional[str] = None,
         v3_enabled: Optional[bool] = None,
         v3_priv_mode: Optional[str] = None,
         v3_priv_pass: Optional[str] = None)
    func NewSnmp(ctx *Context, name string, args SnmpArgs, opts ...ResourceOption) (*Snmp, error)
    public Snmp(string name, SnmpArgs args, CustomResourceOptions? opts = null)
    public Snmp(String name, SnmpArgs args)
public Snmp(String name, SnmpArgs args, CustomResourceOptions options)

    type: meraki:organizations:Snmp
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 SnmpArgs
    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 SnmpArgs
    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 SnmpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SnmpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SnmpArgs
    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 merakiSnmpResource = new Meraki.Organizations.Snmp("merakiSnmpResource", new()
{
    OrganizationId = "string",
    PeerIps = new[]
    {
        "string",
    },
    V2cEnabled = false,
    V3AuthMode = "string",
    V3AuthPass = "string",
    V3Enabled = false,
    V3PrivMode = "string",
    V3PrivPass = "string",
});

    example, err := organizations.NewSnmp(ctx, "merakiSnmpResource", &organizations.SnmpArgs{
	OrganizationId: pulumi.String("string"),
	PeerIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	V2cEnabled: pulumi.Bool(false),
	V3AuthMode: pulumi.String("string"),
	V3AuthPass: pulumi.String("string"),
	V3Enabled:  pulumi.Bool(false),
	V3PrivMode: pulumi.String("string"),
	V3PrivPass: pulumi.String("string"),
})

    var merakiSnmpResource = new Snmp("merakiSnmpResource", SnmpArgs.builder()
    .organizationId("string")
    .peerIps("string")
    .v2cEnabled(false)
    .v3AuthMode("string")
    .v3AuthPass("string")
    .v3Enabled(false)
    .v3PrivMode("string")
    .v3PrivPass("string")
    .build());

    meraki_snmp_resource = meraki.organizations.Snmp("merakiSnmpResource",
    organization_id="string",
    peer_ips=["string"],
    v2c_enabled=False,
    v3_auth_mode="string",
    v3_auth_pass="string",
    v3_enabled=False,
    v3_priv_mode="string",
    v3_priv_pass="string")

    const merakiSnmpResource = new meraki.organizations.Snmp("merakiSnmpResource", {
    organizationId: "string",
    peerIps: ["string"],
    v2cEnabled: false,
    v3AuthMode: "string",
    v3AuthPass: "string",
    v3Enabled: false,
    v3PrivMode: "string",
    v3PrivPass: "string",
});

    type: meraki:organizations:Snmp
properties:
    organizationId: string
    peerIps:
        - string
    v2cEnabled: false
    v3AuthMode: string
    v3AuthPass: string
    v3Enabled: false
    v3PrivMode: string
    v3PrivPass: string

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

    OrganizationId string
    organizationId path parameter. Organization ID
    PeerIps List<string>
    The list of IPv4 addresses that are allowed to access the SNMP server.
    V2cEnabled bool
    Boolean indicating whether SNMP version 2c is enabled for the organization.
    V3AuthMode string
    The SNMP version 3 authentication mode. Can be either 'MD5' or 'SHA'.
    V3AuthPass string
    The SNMP version 3 authentication password. Must be at least 8 characters if specified.
    V3Enabled bool
    Boolean indicating whether SNMP version 3 is enabled for the organization.
    V3PrivMode string
    The SNMP version 3 privacy mode. Can be either 'DES' or 'AES128'.
    V3PrivPass string
    The SNMP version 3 privacy password. Must be at least 8 characters if specified.
    OrganizationId string
    organizationId path parameter. Organization ID
    PeerIps []string
    The list of IPv4 addresses that are allowed to access the SNMP server.
    V2cEnabled bool
    Boolean indicating whether SNMP version 2c is enabled for the organization.
    V3AuthMode string
    The SNMP version 3 authentication mode. Can be either 'MD5' or 'SHA'.
    V3AuthPass string
    The SNMP version 3 authentication password. Must be at least 8 characters if specified.
    V3Enabled bool
    Boolean indicating whether SNMP version 3 is enabled for the organization.
    V3PrivMode string
    The SNMP version 3 privacy mode. Can be either 'DES' or 'AES128'.
    V3PrivPass string
    The SNMP version 3 privacy password. Must be at least 8 characters if specified.
    organizationId String
    organizationId path parameter. Organization ID
    peerIps List<String>
    The list of IPv4 addresses that are allowed to access the SNMP server.
    v2cEnabled Boolean
    Boolean indicating whether SNMP version 2c is enabled for the organization.
    v3AuthMode String
    The SNMP version 3 authentication mode. Can be either 'MD5' or 'SHA'.
    v3AuthPass String
    The SNMP version 3 authentication password. Must be at least 8 characters if specified.
    v3Enabled Boolean
    Boolean indicating whether SNMP version 3 is enabled for the organization.
    v3PrivMode String
    The SNMP version 3 privacy mode. Can be either 'DES' or 'AES128'.
    v3PrivPass String
    The SNMP version 3 privacy password. Must be at least 8 characters if specified.
    organizationId string
    organizationId path parameter. Organization ID
    peerIps string[]
    The list of IPv4 addresses that are allowed to access the SNMP server.
    v2cEnabled boolean
    Boolean indicating whether SNMP version 2c is enabled for the organization.
    v3AuthMode string
    The SNMP version 3 authentication mode. Can be either 'MD5' or 'SHA'.
    v3AuthPass string
    The SNMP version 3 authentication password. Must be at least 8 characters if specified.
    v3Enabled boolean
    Boolean indicating whether SNMP version 3 is enabled for the organization.
    v3PrivMode string
    The SNMP version 3 privacy mode. Can be either 'DES' or 'AES128'.
    v3PrivPass string
    The SNMP version 3 privacy password. Must be at least 8 characters if specified.
    organization_id str
    organizationId path parameter. Organization ID
    peer_ips Sequence[str]
    The list of IPv4 addresses that are allowed to access the SNMP server.
    v2c_enabled bool
    Boolean indicating whether SNMP version 2c is enabled for the organization.
    v3_auth_mode str
    The SNMP version 3 authentication mode. Can be either 'MD5' or 'SHA'.
    v3_auth_pass str
    The SNMP version 3 authentication password. Must be at least 8 characters if specified.
    v3_enabled bool
    Boolean indicating whether SNMP version 3 is enabled for the organization.
    v3_priv_mode str
    The SNMP version 3 privacy mode. Can be either 'DES' or 'AES128'.
    v3_priv_pass str
    The SNMP version 3 privacy password. Must be at least 8 characters if specified.
    organizationId String
    organizationId path parameter. Organization ID
    peerIps List<String>
    The list of IPv4 addresses that are allowed to access the SNMP server.
    v2cEnabled Boolean
    Boolean indicating whether SNMP version 2c is enabled for the organization.
    v3AuthMode String
    The SNMP version 3 authentication mode. Can be either 'MD5' or 'SHA'.
    v3AuthPass String
    The SNMP version 3 authentication password. Must be at least 8 characters if specified.
    v3Enabled Boolean
    Boolean indicating whether SNMP version 3 is enabled for the organization.
    v3PrivMode String
    The SNMP version 3 privacy mode. Can be either 'DES' or 'AES128'.
    v3PrivPass String
    The SNMP version 3 privacy password. Must be at least 8 characters if specified.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Snmp resource produces the following output properties:

    Hostname string
    The hostname of the SNMP server.
    Id string
    The provider-assigned unique ID for this managed resource.
    Port int
    The port of the SNMP server.
    V2CommunityString string
    The community string for SNMP version 2c, if enabled.
    V3User string
    The user for SNMP version 3, if enabled.
    Hostname string
    The hostname of the SNMP server.
    Id string
    The provider-assigned unique ID for this managed resource.
    Port int
    The port of the SNMP server.
    V2CommunityString string
    The community string for SNMP version 2c, if enabled.
    V3User string
    The user for SNMP version 3, if enabled.
    hostname String
    The hostname of the SNMP server.
    id String
    The provider-assigned unique ID for this managed resource.
    port Integer
    The port of the SNMP server.
    v2CommunityString String
    The community string for SNMP version 2c, if enabled.
    v3User String
    The user for SNMP version 3, if enabled.
    hostname string
    The hostname of the SNMP server.
    id string
    The provider-assigned unique ID for this managed resource.
    port number
    The port of the SNMP server.
    v2CommunityString string
    The community string for SNMP version 2c, if enabled.
    v3User string
    The user for SNMP version 3, if enabled.
    hostname str
    The hostname of the SNMP server.
    id str
    The provider-assigned unique ID for this managed resource.
    port int
    The port of the SNMP server.
    v2_community_string str
    The community string for SNMP version 2c, if enabled.
    v3_user str
    The user for SNMP version 3, if enabled.
    hostname String
    The hostname of the SNMP server.
    id String
    The provider-assigned unique ID for this managed resource.
    port Number
    The port of the SNMP server.
    v2CommunityString String
    The community string for SNMP version 2c, if enabled.
    v3User String
    The user for SNMP version 3, if enabled.

    Look up Existing Snmp Resource

    Get an existing Snmp 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?: SnmpState, opts?: CustomResourceOptions): Snmp
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        hostname: Optional[str] = None,
        organization_id: Optional[str] = None,
        peer_ips: Optional[Sequence[str]] = None,
        port: Optional[int] = None,
        v2_community_string: Optional[str] = None,
        v2c_enabled: Optional[bool] = None,
        v3_auth_mode: Optional[str] = None,
        v3_auth_pass: Optional[str] = None,
        v3_enabled: Optional[bool] = None,
        v3_priv_mode: Optional[str] = None,
        v3_priv_pass: Optional[str] = None,
        v3_user: Optional[str] = None) -> Snmp
    func GetSnmp(ctx *Context, name string, id IDInput, state *SnmpState, opts ...ResourceOption) (*Snmp, error)
    public static Snmp Get(string name, Input<string> id, SnmpState? state, CustomResourceOptions? opts = null)
    public static Snmp get(String name, Output<String> id, SnmpState 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:
    Hostname string
    The hostname of the SNMP server.
    OrganizationId string
    organizationId path parameter. Organization ID
    PeerIps List<string>
    The list of IPv4 addresses that are allowed to access the SNMP server.
    Port int
    The port of the SNMP server.
    V2CommunityString string
    The community string for SNMP version 2c, if enabled.
    V2cEnabled bool
    Boolean indicating whether SNMP version 2c is enabled for the organization.
    V3AuthMode string
    The SNMP version 3 authentication mode. Can be either 'MD5' or 'SHA'.
    V3AuthPass string
    The SNMP version 3 authentication password. Must be at least 8 characters if specified.
    V3Enabled bool
    Boolean indicating whether SNMP version 3 is enabled for the organization.
    V3PrivMode string
    The SNMP version 3 privacy mode. Can be either 'DES' or 'AES128'.
    V3PrivPass string
    The SNMP version 3 privacy password. Must be at least 8 characters if specified.
    V3User string
    The user for SNMP version 3, if enabled.
    Hostname string
    The hostname of the SNMP server.
    OrganizationId string
    organizationId path parameter. Organization ID
    PeerIps []string
    The list of IPv4 addresses that are allowed to access the SNMP server.
    Port int
    The port of the SNMP server.
    V2CommunityString string
    The community string for SNMP version 2c, if enabled.
    V2cEnabled bool
    Boolean indicating whether SNMP version 2c is enabled for the organization.
    V3AuthMode string
    The SNMP version 3 authentication mode. Can be either 'MD5' or 'SHA'.
    V3AuthPass string
    The SNMP version 3 authentication password. Must be at least 8 characters if specified.
    V3Enabled bool
    Boolean indicating whether SNMP version 3 is enabled for the organization.
    V3PrivMode string
    The SNMP version 3 privacy mode. Can be either 'DES' or 'AES128'.
    V3PrivPass string
    The SNMP version 3 privacy password. Must be at least 8 characters if specified.
    V3User string
    The user for SNMP version 3, if enabled.
    hostname String
    The hostname of the SNMP server.
    organizationId String
    organizationId path parameter. Organization ID
    peerIps List<String>
    The list of IPv4 addresses that are allowed to access the SNMP server.
    port Integer
    The port of the SNMP server.
    v2CommunityString String
    The community string for SNMP version 2c, if enabled.
    v2cEnabled Boolean
    Boolean indicating whether SNMP version 2c is enabled for the organization.
    v3AuthMode String
    The SNMP version 3 authentication mode. Can be either 'MD5' or 'SHA'.
    v3AuthPass String
    The SNMP version 3 authentication password. Must be at least 8 characters if specified.
    v3Enabled Boolean
    Boolean indicating whether SNMP version 3 is enabled for the organization.
    v3PrivMode String
    The SNMP version 3 privacy mode. Can be either 'DES' or 'AES128'.
    v3PrivPass String
    The SNMP version 3 privacy password. Must be at least 8 characters if specified.
    v3User String
    The user for SNMP version 3, if enabled.
    hostname string
    The hostname of the SNMP server.
    organizationId string
    organizationId path parameter. Organization ID
    peerIps string[]
    The list of IPv4 addresses that are allowed to access the SNMP server.
    port number
    The port of the SNMP server.
    v2CommunityString string
    The community string for SNMP version 2c, if enabled.
    v2cEnabled boolean
    Boolean indicating whether SNMP version 2c is enabled for the organization.
    v3AuthMode string
    The SNMP version 3 authentication mode. Can be either 'MD5' or 'SHA'.
    v3AuthPass string
    The SNMP version 3 authentication password. Must be at least 8 characters if specified.
    v3Enabled boolean
    Boolean indicating whether SNMP version 3 is enabled for the organization.
    v3PrivMode string
    The SNMP version 3 privacy mode. Can be either 'DES' or 'AES128'.
    v3PrivPass string
    The SNMP version 3 privacy password. Must be at least 8 characters if specified.
    v3User string
    The user for SNMP version 3, if enabled.
    hostname str
    The hostname of the SNMP server.
    organization_id str
    organizationId path parameter. Organization ID
    peer_ips Sequence[str]
    The list of IPv4 addresses that are allowed to access the SNMP server.
    port int
    The port of the SNMP server.
    v2_community_string str
    The community string for SNMP version 2c, if enabled.
    v2c_enabled bool
    Boolean indicating whether SNMP version 2c is enabled for the organization.
    v3_auth_mode str
    The SNMP version 3 authentication mode. Can be either 'MD5' or 'SHA'.
    v3_auth_pass str
    The SNMP version 3 authentication password. Must be at least 8 characters if specified.
    v3_enabled bool
    Boolean indicating whether SNMP version 3 is enabled for the organization.
    v3_priv_mode str
    The SNMP version 3 privacy mode. Can be either 'DES' or 'AES128'.
    v3_priv_pass str
    The SNMP version 3 privacy password. Must be at least 8 characters if specified.
    v3_user str
    The user for SNMP version 3, if enabled.
    hostname String
    The hostname of the SNMP server.
    organizationId String
    organizationId path parameter. Organization ID
    peerIps List<String>
    The list of IPv4 addresses that are allowed to access the SNMP server.
    port Number
    The port of the SNMP server.
    v2CommunityString String
    The community string for SNMP version 2c, if enabled.
    v2cEnabled Boolean
    Boolean indicating whether SNMP version 2c is enabled for the organization.
    v3AuthMode String
    The SNMP version 3 authentication mode. Can be either 'MD5' or 'SHA'.
    v3AuthPass String
    The SNMP version 3 authentication password. Must be at least 8 characters if specified.
    v3Enabled Boolean
    Boolean indicating whether SNMP version 3 is enabled for the organization.
    v3PrivMode String
    The SNMP version 3 privacy mode. Can be either 'DES' or 'AES128'.
    v3PrivPass String
    The SNMP version 3 privacy password. Must be at least 8 characters if specified.
    v3User String
    The user for SNMP version 3, if enabled.

    Import

    $ pulumi import meraki:organizations/snmp:Snmp example "organization_id"

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

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
    pulumi/pulumi-meraki