@pulumi/sdwan
Version:
A Pulumi package for managing resources on Cisco Catalyst SD-WAN.. Based on terraform-provider-sdwan: version v0.4.1
282 lines (281 loc) • 8.57 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* This resource can manage a System SNMP Feature.
* - Minimum SD-WAN Manager version: `20.12.0`
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as sdwan from "@pulumi/sdwan";
*
* const example = new sdwan.SystemSnmpFeature("example", {
* name: "Example",
* description: "My Example",
* featureProfileId: "f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
* shutdown: false,
* contactPerson: "wixie.cisco",
* locationOfDevice: "SHANGHAI",
* views: [{
* name: "VIEW1",
* oids: [{
* id: "1.3.6.1.4.1.9.9.394",
* exclude: false,
* }],
* }],
* communities: [{
* name: "example",
* userLabel: "COMMUNITY1",
* view: "VIEW1",
* authorization: "read-only",
* }],
* groups: [{
* name: "GROUP1",
* securityLevel: "auth-priv",
* view: "VIEW1",
* }],
* users: [{
* name: "USER1",
* authenticationProtocol: "sha",
* authenticationPassword: "$CRYPT_CLUSTER$su56l1Z0Tk4Qc9N7+T/uOg==$sD6b0HLqEdI+RNwsEOoLcQ==",
* privacyProtocol: "aes-256-cfb-128",
* privacyPassword: "$CRYPT_CLUSTER$su56l1Z0Tk4Qc9N7+T/uOg==$sD6b0HLqEdI+RNwsEOoLcQ==",
* group: "GROUP1",
* }],
* trapTargetServers: [{
* vpnId: 1,
* ip: "10.75.221.156",
* port: 161,
* userLabel: "TARGET1",
* user: "USER1",
* sourceInterface: "GigabitEthernet1",
* }],
* });
* ```
*
* ## Import
*
* The `pulumi import` command can be used, for example:
*
* Expected import identifier with the format: "system_snmp_feature_id,feature_profile_id"
*
* ```sh
* $ pulumi import sdwan:index/systemSnmpFeature:SystemSnmpFeature example "f6b2c44c-693c-4763-b010-895aa3d236bd,f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"
* ```
*/
export declare class SystemSnmpFeature extends pulumi.CustomResource {
/**
* Get an existing SystemSnmpFeature 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?: SystemSnmpFeatureState, opts?: pulumi.CustomResourceOptions): SystemSnmpFeature;
/**
* Returns true if the given object is an instance of SystemSnmpFeature. 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 SystemSnmpFeature;
/**
* Configure SNMP community
*/
readonly communities: pulumi.Output<outputs.SystemSnmpFeatureCommunity[] | undefined>;
/**
* Set the contact for this managed node
*/
readonly contactPerson: pulumi.Output<string | undefined>;
/**
* Variable name
*/
readonly contactPersonVariable: pulumi.Output<string | undefined>;
/**
* The description of the Feature
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Feature Profile ID
*/
readonly featureProfileId: pulumi.Output<string>;
/**
* Configure an SNMP group
*/
readonly groups: pulumi.Output<outputs.SystemSnmpFeatureGroup[] | undefined>;
/**
* Set the physical location of this managed node
*/
readonly locationOfDevice: pulumi.Output<string | undefined>;
/**
* Variable name
*/
readonly locationOfDeviceVariable: pulumi.Output<string | undefined>;
/**
* The name of the Feature
*/
readonly name: pulumi.Output<string>;
/**
* Enable or disable SNMP
* - Default value: `false`
*/
readonly shutdown: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly shutdownVariable: pulumi.Output<string | undefined>;
/**
* Configure SNMP server to receive SNMP traps
*/
readonly trapTargetServers: pulumi.Output<outputs.SystemSnmpFeatureTrapTargetServer[] | undefined>;
/**
* Configure an SNMP user
*/
readonly users: pulumi.Output<outputs.SystemSnmpFeatureUser[] | undefined>;
/**
* The version of the Feature
*/
readonly version: pulumi.Output<number>;
/**
* Configure a view record
*/
readonly views: pulumi.Output<outputs.SystemSnmpFeatureView[] | undefined>;
/**
* Create a SystemSnmpFeature 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: SystemSnmpFeatureArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SystemSnmpFeature resources.
*/
export interface SystemSnmpFeatureState {
/**
* Configure SNMP community
*/
communities?: pulumi.Input<pulumi.Input<inputs.SystemSnmpFeatureCommunity>[]>;
/**
* Set the contact for this managed node
*/
contactPerson?: pulumi.Input<string>;
/**
* Variable name
*/
contactPersonVariable?: pulumi.Input<string>;
/**
* The description of the Feature
*/
description?: pulumi.Input<string>;
/**
* Feature Profile ID
*/
featureProfileId?: pulumi.Input<string>;
/**
* Configure an SNMP group
*/
groups?: pulumi.Input<pulumi.Input<inputs.SystemSnmpFeatureGroup>[]>;
/**
* Set the physical location of this managed node
*/
locationOfDevice?: pulumi.Input<string>;
/**
* Variable name
*/
locationOfDeviceVariable?: pulumi.Input<string>;
/**
* The name of the Feature
*/
name?: pulumi.Input<string>;
/**
* Enable or disable SNMP
* - Default value: `false`
*/
shutdown?: pulumi.Input<boolean>;
/**
* Variable name
*/
shutdownVariable?: pulumi.Input<string>;
/**
* Configure SNMP server to receive SNMP traps
*/
trapTargetServers?: pulumi.Input<pulumi.Input<inputs.SystemSnmpFeatureTrapTargetServer>[]>;
/**
* Configure an SNMP user
*/
users?: pulumi.Input<pulumi.Input<inputs.SystemSnmpFeatureUser>[]>;
/**
* The version of the Feature
*/
version?: pulumi.Input<number>;
/**
* Configure a view record
*/
views?: pulumi.Input<pulumi.Input<inputs.SystemSnmpFeatureView>[]>;
}
/**
* The set of arguments for constructing a SystemSnmpFeature resource.
*/
export interface SystemSnmpFeatureArgs {
/**
* Configure SNMP community
*/
communities?: pulumi.Input<pulumi.Input<inputs.SystemSnmpFeatureCommunity>[]>;
/**
* Set the contact for this managed node
*/
contactPerson?: pulumi.Input<string>;
/**
* Variable name
*/
contactPersonVariable?: pulumi.Input<string>;
/**
* The description of the Feature
*/
description?: pulumi.Input<string>;
/**
* Feature Profile ID
*/
featureProfileId: pulumi.Input<string>;
/**
* Configure an SNMP group
*/
groups?: pulumi.Input<pulumi.Input<inputs.SystemSnmpFeatureGroup>[]>;
/**
* Set the physical location of this managed node
*/
locationOfDevice?: pulumi.Input<string>;
/**
* Variable name
*/
locationOfDeviceVariable?: pulumi.Input<string>;
/**
* The name of the Feature
*/
name?: pulumi.Input<string>;
/**
* Enable or disable SNMP
* - Default value: `false`
*/
shutdown?: pulumi.Input<boolean>;
/**
* Variable name
*/
shutdownVariable?: pulumi.Input<string>;
/**
* Configure SNMP server to receive SNMP traps
*/
trapTargetServers?: pulumi.Input<pulumi.Input<inputs.SystemSnmpFeatureTrapTargetServer>[]>;
/**
* Configure an SNMP user
*/
users?: pulumi.Input<pulumi.Input<inputs.SystemSnmpFeatureUser>[]>;
/**
* Configure a view record
*/
views?: pulumi.Input<pulumi.Input<inputs.SystemSnmpFeatureView>[]>;
}