@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
191 lines • 6.55 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* 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
*
* ```sh
* $ pulumi import meraki:organizations/snmp:Snmp example "organization_id"
* ```
*/
export declare class Snmp extends pulumi.CustomResource {
/**
* Get an existing Snmp resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SnmpState, opts?: pulumi.CustomResourceOptions): Snmp;
/**
* Returns true if the given object is an instance of Snmp. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Snmp;
/**
* The hostname of the SNMP server.
*/
readonly hostname: pulumi.Output<string>;
/**
* organizationId path parameter. Organization ID
*/
readonly organizationId: pulumi.Output<string>;
/**
* The list of IPv4 addresses that are allowed to access the SNMP server.
*/
readonly peerIps: pulumi.Output<string[]>;
/**
* The port of the SNMP server.
*/
readonly port: pulumi.Output<number>;
/**
* The community string for SNMP version 2c, if enabled.
*/
readonly v2CommunityString: pulumi.Output<string>;
/**
* Boolean indicating whether SNMP version 2c is enabled for the organization.
*/
readonly v2cEnabled: pulumi.Output<boolean>;
/**
* The SNMP version 3 authentication mode. Can be either 'MD5' or 'SHA'.
*/
readonly v3AuthMode: pulumi.Output<string>;
/**
* The SNMP version 3 authentication password. Must be at least 8 characters if specified.
*/
readonly v3AuthPass: pulumi.Output<string>;
/**
* Boolean indicating whether SNMP version 3 is enabled for the organization.
*/
readonly v3Enabled: pulumi.Output<boolean>;
/**
* The SNMP version 3 privacy mode. Can be either 'DES' or 'AES128'.
*/
readonly v3PrivMode: pulumi.Output<string>;
/**
* The SNMP version 3 privacy password. Must be at least 8 characters if specified.
*/
readonly v3PrivPass: pulumi.Output<string>;
/**
* The user for SNMP version 3, if enabled.
*/
readonly v3User: pulumi.Output<string>;
/**
* Create a Snmp resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: SnmpArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Snmp resources.
*/
export interface SnmpState {
/**
* The hostname of the SNMP server.
*/
hostname?: pulumi.Input<string | undefined>;
/**
* organizationId path parameter. Organization ID
*/
organizationId?: pulumi.Input<string | undefined>;
/**
* The list of IPv4 addresses that are allowed to access the SNMP server.
*/
peerIps?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The port of the SNMP server.
*/
port?: pulumi.Input<number | undefined>;
/**
* The community string for SNMP version 2c, if enabled.
*/
v2CommunityString?: pulumi.Input<string | undefined>;
/**
* Boolean indicating whether SNMP version 2c is enabled for the organization.
*/
v2cEnabled?: pulumi.Input<boolean | undefined>;
/**
* The SNMP version 3 authentication mode. Can be either 'MD5' or 'SHA'.
*/
v3AuthMode?: pulumi.Input<string | undefined>;
/**
* The SNMP version 3 authentication password. Must be at least 8 characters if specified.
*/
v3AuthPass?: pulumi.Input<string | undefined>;
/**
* Boolean indicating whether SNMP version 3 is enabled for the organization.
*/
v3Enabled?: pulumi.Input<boolean | undefined>;
/**
* The SNMP version 3 privacy mode. Can be either 'DES' or 'AES128'.
*/
v3PrivMode?: pulumi.Input<string | undefined>;
/**
* The SNMP version 3 privacy password. Must be at least 8 characters if specified.
*/
v3PrivPass?: pulumi.Input<string | undefined>;
/**
* The user for SNMP version 3, if enabled.
*/
v3User?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Snmp resource.
*/
export interface SnmpArgs {
/**
* organizationId path parameter. Organization ID
*/
organizationId: pulumi.Input<string>;
/**
* The list of IPv4 addresses that are allowed to access the SNMP server.
*/
peerIps?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Boolean indicating whether SNMP version 2c is enabled for the organization.
*/
v2cEnabled?: pulumi.Input<boolean | undefined>;
/**
* The SNMP version 3 authentication mode. Can be either 'MD5' or 'SHA'.
*/
v3AuthMode?: pulumi.Input<string | undefined>;
/**
* The SNMP version 3 authentication password. Must be at least 8 characters if specified.
*/
v3AuthPass?: pulumi.Input<string | undefined>;
/**
* Boolean indicating whether SNMP version 3 is enabled for the organization.
*/
v3Enabled?: pulumi.Input<boolean | undefined>;
/**
* The SNMP version 3 privacy mode. Can be either 'DES' or 'AES128'.
*/
v3PrivMode?: pulumi.Input<string | undefined>;
/**
* The SNMP version 3 privacy password. Must be at least 8 characters if specified.
*/
v3PrivPass?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=snmp.d.ts.map