@pulumi/sdwan
Version:
A Pulumi package for managing resources on Cisco Catalyst SD-WAN.. Based on terraform-provider-sdwan: version v0.4.1
483 lines (482 loc) • 14.9 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 Service Multicast 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.ServiceMulticastFeature("example", {
* name: "Example",
* description: "My Example",
* featureProfileId: "f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
* sptOnly: false,
* localReplicator: false,
* localReplicatorThreshold: 10,
* igmpInterfaces: [{
* interfaceName: "GigabitEthernet1",
* version: 2,
* joinGroups: [{
* groupAddress: "224.0.0.0",
* sourceAddress: "1.2.3.4",
* }],
* }],
* pimSourceSpecificMulticastEnable: true,
* pimSourceSpecificMulticastAccessList: "1",
* pimSptThreshold: "0",
* pimInterfaces: [{
* interfaceName: "GigabitEthernet1",
* queryInterval: 30,
* joinPruneInterval: 60,
* }],
* staticRpAddresses: [{
* ipAddress: "1.2.3.4",
* accessList: "1",
* override: false,
* }],
* enableAutoRp: false,
* pimBsrRpCandidates: [{
* interfaceName: "GigabitEthernet1",
* accessListId: "2",
* interval: 30,
* priority: 1,
* }],
* pimBsrCandidates: [{
* interfaceName: "GigabitEthernet1",
* hashMaskLength: 30,
* priority: 120,
* acceptCandidateAccessList: "test",
* }],
* msdpGroups: [{
* meshGroupName: "Example",
* peers: [{
* peerIp: "1.2.3.4",
* connectionSourceInterface: "GigabitEthernet1",
* remoteAs: 1,
* peerAuthenticationPassword: "Password123!",
* keepaliveInterval: 15,
* keepaliveHoldTime: 30,
* saLimit: 1,
* defaultPeer: false,
* }],
* }],
* msdpOriginatorId: "GigabitEthernet1",
* msdpConnectionRetryInterval: 30,
* });
* ```
*
* ## Import
*
* The `pulumi import` command can be used, for example:
*
* Expected import identifier with the format: "service_multicast_feature_id,feature_profile_id"
*
* ```sh
* $ pulumi import sdwan:index/serviceMulticastFeature:ServiceMulticastFeature example "f6b2c44c-693c-4763-b010-895aa3d236bd,f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"
* ```
*/
export declare class ServiceMulticastFeature extends pulumi.CustomResource {
/**
* Get an existing ServiceMulticastFeature 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?: ServiceMulticastFeatureState, opts?: pulumi.CustomResourceOptions): ServiceMulticastFeature;
/**
* Returns true if the given object is an instance of ServiceMulticastFeature. 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 ServiceMulticastFeature;
/**
* Enable or disable RP Announce
*/
readonly autoRpAnnounces: pulumi.Output<outputs.ServiceMulticastFeatureAutoRpAnnounce[] | undefined>;
/**
* Enable or disable RP Discovery
*/
readonly autoRpDiscoveries: pulumi.Output<outputs.ServiceMulticastFeatureAutoRpDiscovery[] | undefined>;
/**
* The description of the Feature
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Enable or disable auto-RP
* - Default value: `false`
*/
readonly enableAutoRp: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly enableAutoRpVariable: pulumi.Output<string | undefined>;
/**
* Feature Profile ID
*/
readonly featureProfileId: pulumi.Output<string>;
/**
* Set IGMP interface parameters
*/
readonly igmpInterfaces: pulumi.Output<outputs.ServiceMulticastFeatureIgmpInterface[] | undefined>;
/**
* Replicator is local to this device
* - Default value: `false`
*/
readonly localReplicator: pulumi.Output<boolean | undefined>;
/**
* Set number of joins per group the router supports
* - Range: `0`-`131072`
*/
readonly localReplicatorThreshold: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly localReplicatorThresholdVariable: pulumi.Output<string | undefined>;
/**
* Variable name
*/
readonly localReplicatorVariable: pulumi.Output<string | undefined>;
/**
* Set MSDP refresh timer
* - Range: `1`-`60`
*/
readonly msdpConnectionRetryInterval: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly msdpConnectionRetryIntervalVariable: pulumi.Output<string | undefined>;
/**
* multicast MSDP peer
*/
readonly msdpGroups: pulumi.Output<outputs.ServiceMulticastFeatureMsdpGroup[] | undefined>;
/**
* Set MSDP originator ID
*/
readonly msdpOriginatorId: pulumi.Output<string | undefined>;
/**
* Variable name
*/
readonly msdpOriginatorIdVariable: pulumi.Output<string | undefined>;
/**
* The name of the Feature
*/
readonly name: pulumi.Output<string>;
/**
* bsr candidate Attributes
*/
readonly pimBsrCandidates: pulumi.Output<outputs.ServiceMulticastFeaturePimBsrCandidate[] | undefined>;
/**
* Set RP Discovery Scope
*/
readonly pimBsrRpCandidates: pulumi.Output<outputs.ServiceMulticastFeaturePimBsrRpCandidate[] | undefined>;
/**
* Set PIM interface parameters
*/
readonly pimInterfaces: pulumi.Output<outputs.ServiceMulticastFeaturePimInterface[] | undefined>;
/**
* Set Access List for PIM SSM
*/
readonly pimSourceSpecificMulticastAccessList: pulumi.Output<string | undefined>;
/**
* Variable name
*/
readonly pimSourceSpecificMulticastAccessListVariable: pulumi.Output<string | undefined>;
/**
* turn SSM on/off
*/
readonly pimSourceSpecificMulticastEnable: pulumi.Output<boolean>;
/**
* Set when PIM router joins the SPT (kbps)
* - Choices: `0`, `infinity`
* - Default value: `0`
*/
readonly pimSptThreshold: pulumi.Output<string | undefined>;
/**
* Variable name
*/
readonly pimSptThresholdVariable: pulumi.Output<string | undefined>;
/**
* Shortest Path Tree (SPT) Only Mode
* - Default value: `false`
*/
readonly sptOnly: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly sptOnlyVariable: pulumi.Output<string | undefined>;
/**
* Set Static RP Address(es)
*/
readonly staticRpAddresses: pulumi.Output<outputs.ServiceMulticastFeatureStaticRpAddress[] | undefined>;
/**
* The version of the Feature
*/
readonly version: pulumi.Output<number>;
/**
* Create a ServiceMulticastFeature 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: ServiceMulticastFeatureArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ServiceMulticastFeature resources.
*/
export interface ServiceMulticastFeatureState {
/**
* Enable or disable RP Announce
*/
autoRpAnnounces?: pulumi.Input<pulumi.Input<inputs.ServiceMulticastFeatureAutoRpAnnounce>[]>;
/**
* Enable or disable RP Discovery
*/
autoRpDiscoveries?: pulumi.Input<pulumi.Input<inputs.ServiceMulticastFeatureAutoRpDiscovery>[]>;
/**
* The description of the Feature
*/
description?: pulumi.Input<string>;
/**
* Enable or disable auto-RP
* - Default value: `false`
*/
enableAutoRp?: pulumi.Input<boolean>;
/**
* Variable name
*/
enableAutoRpVariable?: pulumi.Input<string>;
/**
* Feature Profile ID
*/
featureProfileId?: pulumi.Input<string>;
/**
* Set IGMP interface parameters
*/
igmpInterfaces?: pulumi.Input<pulumi.Input<inputs.ServiceMulticastFeatureIgmpInterface>[]>;
/**
* Replicator is local to this device
* - Default value: `false`
*/
localReplicator?: pulumi.Input<boolean>;
/**
* Set number of joins per group the router supports
* - Range: `0`-`131072`
*/
localReplicatorThreshold?: pulumi.Input<number>;
/**
* Variable name
*/
localReplicatorThresholdVariable?: pulumi.Input<string>;
/**
* Variable name
*/
localReplicatorVariable?: pulumi.Input<string>;
/**
* Set MSDP refresh timer
* - Range: `1`-`60`
*/
msdpConnectionRetryInterval?: pulumi.Input<number>;
/**
* Variable name
*/
msdpConnectionRetryIntervalVariable?: pulumi.Input<string>;
/**
* multicast MSDP peer
*/
msdpGroups?: pulumi.Input<pulumi.Input<inputs.ServiceMulticastFeatureMsdpGroup>[]>;
/**
* Set MSDP originator ID
*/
msdpOriginatorId?: pulumi.Input<string>;
/**
* Variable name
*/
msdpOriginatorIdVariable?: pulumi.Input<string>;
/**
* The name of the Feature
*/
name?: pulumi.Input<string>;
/**
* bsr candidate Attributes
*/
pimBsrCandidates?: pulumi.Input<pulumi.Input<inputs.ServiceMulticastFeaturePimBsrCandidate>[]>;
/**
* Set RP Discovery Scope
*/
pimBsrRpCandidates?: pulumi.Input<pulumi.Input<inputs.ServiceMulticastFeaturePimBsrRpCandidate>[]>;
/**
* Set PIM interface parameters
*/
pimInterfaces?: pulumi.Input<pulumi.Input<inputs.ServiceMulticastFeaturePimInterface>[]>;
/**
* Set Access List for PIM SSM
*/
pimSourceSpecificMulticastAccessList?: pulumi.Input<string>;
/**
* Variable name
*/
pimSourceSpecificMulticastAccessListVariable?: pulumi.Input<string>;
/**
* turn SSM on/off
*/
pimSourceSpecificMulticastEnable?: pulumi.Input<boolean>;
/**
* Set when PIM router joins the SPT (kbps)
* - Choices: `0`, `infinity`
* - Default value: `0`
*/
pimSptThreshold?: pulumi.Input<string>;
/**
* Variable name
*/
pimSptThresholdVariable?: pulumi.Input<string>;
/**
* Shortest Path Tree (SPT) Only Mode
* - Default value: `false`
*/
sptOnly?: pulumi.Input<boolean>;
/**
* Variable name
*/
sptOnlyVariable?: pulumi.Input<string>;
/**
* Set Static RP Address(es)
*/
staticRpAddresses?: pulumi.Input<pulumi.Input<inputs.ServiceMulticastFeatureStaticRpAddress>[]>;
/**
* The version of the Feature
*/
version?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a ServiceMulticastFeature resource.
*/
export interface ServiceMulticastFeatureArgs {
/**
* Enable or disable RP Announce
*/
autoRpAnnounces?: pulumi.Input<pulumi.Input<inputs.ServiceMulticastFeatureAutoRpAnnounce>[]>;
/**
* Enable or disable RP Discovery
*/
autoRpDiscoveries?: pulumi.Input<pulumi.Input<inputs.ServiceMulticastFeatureAutoRpDiscovery>[]>;
/**
* The description of the Feature
*/
description?: pulumi.Input<string>;
/**
* Enable or disable auto-RP
* - Default value: `false`
*/
enableAutoRp?: pulumi.Input<boolean>;
/**
* Variable name
*/
enableAutoRpVariable?: pulumi.Input<string>;
/**
* Feature Profile ID
*/
featureProfileId: pulumi.Input<string>;
/**
* Set IGMP interface parameters
*/
igmpInterfaces?: pulumi.Input<pulumi.Input<inputs.ServiceMulticastFeatureIgmpInterface>[]>;
/**
* Replicator is local to this device
* - Default value: `false`
*/
localReplicator?: pulumi.Input<boolean>;
/**
* Set number of joins per group the router supports
* - Range: `0`-`131072`
*/
localReplicatorThreshold?: pulumi.Input<number>;
/**
* Variable name
*/
localReplicatorThresholdVariable?: pulumi.Input<string>;
/**
* Variable name
*/
localReplicatorVariable?: pulumi.Input<string>;
/**
* Set MSDP refresh timer
* - Range: `1`-`60`
*/
msdpConnectionRetryInterval?: pulumi.Input<number>;
/**
* Variable name
*/
msdpConnectionRetryIntervalVariable?: pulumi.Input<string>;
/**
* multicast MSDP peer
*/
msdpGroups?: pulumi.Input<pulumi.Input<inputs.ServiceMulticastFeatureMsdpGroup>[]>;
/**
* Set MSDP originator ID
*/
msdpOriginatorId?: pulumi.Input<string>;
/**
* Variable name
*/
msdpOriginatorIdVariable?: pulumi.Input<string>;
/**
* The name of the Feature
*/
name?: pulumi.Input<string>;
/**
* bsr candidate Attributes
*/
pimBsrCandidates?: pulumi.Input<pulumi.Input<inputs.ServiceMulticastFeaturePimBsrCandidate>[]>;
/**
* Set RP Discovery Scope
*/
pimBsrRpCandidates?: pulumi.Input<pulumi.Input<inputs.ServiceMulticastFeaturePimBsrRpCandidate>[]>;
/**
* Set PIM interface parameters
*/
pimInterfaces?: pulumi.Input<pulumi.Input<inputs.ServiceMulticastFeaturePimInterface>[]>;
/**
* Set Access List for PIM SSM
*/
pimSourceSpecificMulticastAccessList?: pulumi.Input<string>;
/**
* Variable name
*/
pimSourceSpecificMulticastAccessListVariable?: pulumi.Input<string>;
/**
* turn SSM on/off
*/
pimSourceSpecificMulticastEnable: pulumi.Input<boolean>;
/**
* Set when PIM router joins the SPT (kbps)
* - Choices: `0`, `infinity`
* - Default value: `0`
*/
pimSptThreshold?: pulumi.Input<string>;
/**
* Variable name
*/
pimSptThresholdVariable?: pulumi.Input<string>;
/**
* Shortest Path Tree (SPT) Only Mode
* - Default value: `false`
*/
sptOnly?: pulumi.Input<boolean>;
/**
* Variable name
*/
sptOnlyVariable?: pulumi.Input<string>;
/**
* Set Static RP Address(es)
*/
staticRpAddresses?: pulumi.Input<pulumi.Input<inputs.ServiceMulticastFeatureStaticRpAddress>[]>;
}